mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
9ead99bb2b
Generated-By: mintlify-agent Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
60 lines
1.7 KiB
Plaintext
60 lines
1.7 KiB
Plaintext
---
|
|
title: "Campos de respuesta"
|
|
description: "Documenta los campos de respuesta de la API usando el componente ResponseField con anotaciones de tipo, descripciones e indicadores de obligatorio u opcional."
|
|
keywords: ["salida de la API", "valores de retorno", "estructura de la respuesta"]
|
|
---
|
|
|
|
Usa el componente `<ResponseField>` 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 has marcado un campo como obsoleto o no.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="pre" type="string[]">
|
|
Etiquetas que aparecen antes del nombre del campo
|
|
</ResponseField>
|
|
|
|
<ResponseField name="post" type="string[]">
|
|
Etiquetas que aparecen 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> |