Fields

Existem dois tipos de campos: Campos de Parâmetro e Campos de Resposta.

Campo de Parâmetro

Um componenteParamFieldé usado para definir os parâmetros para suas APIs ou SDKs. Adicionar umParamFieldadicionará automaticamente umAPI Playground.

param · string · required

Um exemplo de um 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

Se é um parâmetro de consulta, caminho, corpo ou cabeçalho seguido pelo nome

type · string

Tipo esperado do valor do parâmetro

Suportanumber,string,bool,object.

Arrays podem ser definidos usando o sufixo[]. Por exemplostring[].

required · boolean

Indica se o parâmetro é obrigatório

deprecated · boolean

Indica se o parâmetro está obsoleto

default · string

Valor padrão usado pelo servidor se a solicitação não fornecer um valor

initialValue · any

Valor que será usado para inicializar o playground

placeholder · string

Texto de espaço reservado para a entrada no playground

children · string

Descrição do parâmetro (markdown habilitado)

Campo de Resposta

O componente<ResponseField>é projetado para definir os valores de retorno de uma API. Muitas documentações também usam<ResponseField>em páginas quando você precisa listar os tipos de algo.

response · string · required

Um exemplo de campo de resposta

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

Props

name · string · required

O nome do valor de resposta.

type · string · required

Tipo esperado do valor de resposta - isso pode ser qualquer string arbitrária.

default · string

O valor padrão.

required · boolean

Mostrar “required” ao lado do nome do campo.

deprecated · boolean

Se um campo está obsoleto ou não.

pre · string[]

Rótulos que são mostrados antes do nome do campo

post · string[]

Rótulos que são mostrados após o nome do campo