Skip to main content
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.
string
requerido
Un ejemplo de campo de respuesta

Props

string
requerido
El nombre del valor de la respuesta.
string
requerido
Tipo esperado del valor de la respuesta: puede ser cualquier cadena arbitraria.
string
El valor predeterminado.
boolean
Mostrar “required” junto al nombre del campo.
boolean
Indica si has marcado un campo como obsoleto o no.
string[]
Etiquetas que aparecen antes del nombre del campo
string[]
Etiquetas que aparecen después del nombre del campo