Campo de parámetro
<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.
string
requerido
Un ejemplo de campo de parámetro
Propiedades
string
Indica si el parámetro es de query, ruta, cuerpo o encabezado. Seguido del
nombre del parámetro.
string
Tipo esperado del valor del parámetro.Admite
number, string, boolean, object.Define los arreglos con el sufijo []. Por ejemplo, string[].boolean
Indica si requieres el parámetro.
boolean
Indica si has marcado el parámetro como obsoleto.
any
Valor predeterminado que se aplica cuando el valor de la solicitud está vacío.
string
Texto del marcador de posición para la entrada en el entorno de pruebas.
string
Descripción del parámetro (compatible con Markdown).
Campo de respuesta
<ResponseField> define los valores de retorno de una API.
string
requerido
Un ejemplo de un campo de respuesta
Propiedades
string
requerido
El nombre del valor de la respuesta.
string
requerido
Tipo esperado del valor de la respuesta. Puede ser cualquier cadena arbitraria.
string
Valor predeterminado.
boolean
Indica si requieres la respuesta.
boolean
Indica si has marcado un campo como obsoleto.
string[]
Etiquetas que aparecen antes del nombre del campo.
string[]
Etiquetas que aparecen después del nombre del campo.