Fields

Hay dos tipos de campos: Campos de Parámetros y Campos de Respuesta.

Campo de Parámetro

Un componenteParamFieldse utiliza para definir los parámetros de tus APIs o SDKs. Añadir unParamFieldagregará automáticamente unAPI Playground.

param · string · required

Un ejemplo de un campo de parámetro

Path Example

<ParamField path="param" type="string">
  An example of a parameter field
</ParamField>

Props

query, path, body, or header · string

Si es un parámetro de consulta, ruta, cuerpo o encabezado seguido del nombre

type · string

Tipo esperado del valor del parámetro

Admitenumber,string,bool,object.

Los arrays se pueden definir usando el sufijo[]. Por ejemplostring[].

required · boolean

Indica si el parámetro es obligatorio

deprecated · boolean

Indica si el parámetro está obsoleto

default · string

Valor predeterminado utilizado por el servidor si la solicitud no proporciona un valor

initialValue · any

Valor que se utilizará para inicializar el playground

placeholder · string

Texto de marcador de posición para la entrada en el playground

children · string

Descripción del parámetro (markdown habilitado)

Campo de Respuesta

El componente<ResponseField>está diseñado para definir los valores de retorno de una API. Muchas documentaciones también usan<ResponseField>en las páginas cuando necesitas listar los tipos de algo.

response · string · required

Un ejemplo de campo de respuesta

<ResponseField name="response" type="string" required>
  A response field example
</ResponseField>

Props

name · string · required

El nombre del valor de respuesta.

type · string · required

Tipo esperado del valor de respuesta - esto puede ser cualquier cadena arbitraria.

default · string

El valor predeterminado.

required · boolean

Mostrar “required” junto al nombre del campo.

deprecated · boolean

Si un campo está obsoleto o no.

pre · string[]

Etiquetas que se muestran antes del nombre del campo

post · string[]

Etiquetas que se muestran después del nombre del campo