Saltar al contenido principal
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.
​
response
string
requerido
Un ejemplo de campo de respuesta
<ResponseField name="response" type="string" required>
  Un ejemplo de campo de respuesta
</ResponseField>

​
Props

​
name
string
requerido
El nombre del valor de la respuesta.
​
type
string
requerido
Tipo esperado del valor de la respuesta: puede ser cualquier cadena arbitraria.
​
default
string
El valor predeterminado.
​
required
boolean
Mostrar “required” junto al nombre del campo.
​
deprecated
boolean
Indica si has marcado un campo como obsoleto o no.
​
pre
string[]
Etiquetas que aparecen antes del nombre del campo
​
post
string[]
Etiquetas que aparecen después del nombre del campo
<ResponseField name="response" type="string" required>
  Ejemplo de campo de respuesta
</ResponseField>