Campos
Usa los componentes ParamField y ResponseField para documentar parámetros de solicitud y respuesta de la API con tipos, valores por defecto y validación.
Usa campos para documentar los parámetros y las respuestas de la API. Hay dos tipos de campos: campos de parámetro y campos de respuesta.
Usa el componente <ParamField> para definir parámetros de tus API o SDK. Al agregar un ParamField, se añade automáticamente un área de pruebas de la API.
paramstringrequiredUn ejemplo de campo de parámetro
<ParamField path="param" type="string" required>
Un ejemplo de un campo de parámetro
</ParamField>query, path, body, or headerstringIndica si el parámetro es de query, ruta, cuerpo o encabezado. Seguido del nombre del parámetro.
typestringTipo esperado del valor del parámetro.
Admite number, string, boolean, object.
Define los arreglos con el sufijo []. Por ejemplo, string[].
requiredbooleanIndica si requieres el parámetro.
deprecatedbooleanIndica si has marcado el parámetro como obsoleto.
defaultanyValor predeterminado que se aplica cuando el valor de la solicitud está vacío.
placeholderstringTexto del marcador de posición para la entrada en el entorno de pruebas.
childrenstringDescripción del parámetro (compatible con Markdown).
El componente <ResponseField> define los valores de retorno de una API.
responsestringrequiredUn ejemplo de un 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.
defaultstringValor predeterminado.
requiredbooleanIndica si requieres la respuesta.
deprecatedbooleanIndica si has marcado un campo como obsoleto.
prestring[]Etiquetas que aparecen antes del nombre del campo.
poststring[]Etiquetas que aparecen después del nombre del campo.