mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
locadex-agent[bot]
bbb1a08ed3
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
60 lines
1.6 KiB
Plaintext
60 lines
1.6 KiB
Plaintext
---
|
|
title: "Campos de respuesta"
|
|
description: "Muestra los valores de respuesta de la API."
|
|
keywords: ["salida de la API", "valores de retorno", "estructura de la respuesta"]
|
|
---
|
|
|
|
El componente `<ResponseField>` está diseñado para definir los valores devueltos de una API. Muchos documentos también utilizan `<ResponseField>` en páginas cuando necesitas enumerar los tipos de algo.
|
|
|
|
<ResponseField name="response" type="string" required>
|
|
Un ejemplo de campo de respuesta
|
|
</ResponseField>
|
|
|
|
```mdx
|
|
<ResponseField name="response" type="string" required>
|
|
Un ejemplo de campo de respuesta
|
|
</ResponseField>
|
|
```
|
|
|
|
|
|
<div id="props">
|
|
## Props
|
|
</div>
|
|
|
|
<ResponseField name="name" type="string" required>
|
|
El nombre del valor de la respuesta.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="type" type="string" required>
|
|
Tipo esperado del valor de la respuesta: puede ser cualquier cadena arbitraria.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="default" type="string">
|
|
El valor predeterminado.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="required" type="boolean">
|
|
Mostrar "required" junto al nombre del campo.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="deprecated" type="boolean">
|
|
Indica si un campo está en desuso o no.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="pre" type="string[]">
|
|
Etiquetas que se muestran antes del nombre del campo
|
|
</ResponseField>
|
|
|
|
<ResponseField name="post" type="string[]">
|
|
Etiquetas que se muestran después del nombre del campo
|
|
</ResponseField>
|
|
|
|
<RequestExample>
|
|
|
|
```mdx Response Field Example
|
|
<ResponseField name="response" type="string" required>
|
|
Ejemplo de campo de respuesta
|
|
</ResponseField>
|
|
```
|
|
|
|
</RequestExample> |