Campos de respuesta
Documenta los campos de respuesta de la API usando el componente ResponseField con anotaciones de tipo, descripciones e indicadores de obligatorio u opcional.
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.
responsestringrequiredUn ejemplo de campo de respuesta
<ResponseField name="response" type="string" required>
Un ejemplo de campo de respuesta
</ResponseField>namestringrequiredEl nombre del valor de la respuesta.
typestringrequiredTipo esperado del valor de la respuesta: puede ser cualquier cadena arbitraria.
defaultstringEl valor predeterminado.
requiredbooleanMostrar “required” junto al nombre del campo.
deprecatedbooleanIndica si has marcado un campo como obsoleto o no.
prestring[]Etiquetas que aparecen antes del nombre del campo
poststring[]Etiquetas que aparecen después del nombre del campo
<ResponseField name="response" type="string" required>
Ejemplo de campo de respuesta
</ResponseField>Was this page helpful?Suggest editsRaise issue