Campos

Configura parámetros para tus referencias de API o SDK

Usa campos para documentar parámetros y respuestas de la API. Hay dos tipos de campos: campos de parámetro y campos de respuesta.

​

Campo de parámetro

El componente <ParamField> se usa para definir parámetros de tus API o SDK. Al agregar un ParamField, se añade automáticamente un Área de pruebas de API.

param · string · requerido

Un ejemplo de un campo de parámetro

<ParamField path="param" type="string" required>
  Un ejemplo de un campo de parámetros
</ParamField>

​

Propiedades

query, path, body, or header · string

Indica si el parámetro es de consulta, ruta, cuerpo o encabezado. Luego, el nombre del parámetro.

type · string

Tipo esperado del valor del parámetro.

Admite number, string, boolean, object.

Los arreglos pueden definirse usando el sufijo []. Por ejemplo, string[].

required · boolean

Indica si el parámetro es obligatorio.

deprecated · boolean

Indica si el parámetro está en desuso.

default · any

Valor predeterminado que se aplica cuando el valor de la solicitud está vacío.

placeholder · string

Texto del marcador de posición para el campo en el área de pruebas.

children · string

Descripción del parámetro (con soporte para Markdown).

​

Campo de respuesta

El componente <ResponseField> define los valores de retorno de una API.

response · string · requerido

Ejemplo de un campo de respuesta

<ResponseField name="response" type="string" required>
  Ejemplo de campo de respuesta
</ResponseField>

​

Propiedades

name · string · requerido

El nombre del valor de la respuesta.

type · string · requerido

Tipo esperado del valor de la respuesta. Puede ser cualquier cadena.

default · string

El valor por defecto.

required · boolean

Indica si la respuesta es obligatoria.

deprecated · boolean

Indica si un campo está en desuso.

pre · string[]

Etiquetas que se muestran antes del nombre del campo.

post · string[]

Etiquetas que se muestran después del nombre del campo.