Use campos para documentar parâmetros e respostas de APIs. Há dois tipos de campos: campos de parâmetro e campos de resposta.

​
Campo de parâmetro

O componente <ParamField> é usado para definir parâmetros para suas APIs ou SDKs. Ao adicionar um ParamField, um Playground de API é criado automaticamente.
​
param
string
required
Exemplo de campo de parâmetro
<ParamField path="param" type="string" required>
  Exemplo de campo de parâmetro
</ParamField>

​
Propriedades

​
query, path, body, or header
string
Indica se o parâmetro é de query, path, body ou header, seguido pelo nome do parâmetro.
​
type
string
Tipo esperado do valor do parâmetro.Suporta number, string, boolean, object.Arrays podem ser definidos com o sufixo []. Por exemplo, string[].
​
required
boolean
Indica se o parâmetro é obrigatório.
​
deprecated
boolean
Indica se o parâmetro está obsoleto.
​
default
any
Valor padrão aplicado quando o valor da requisição estiver vazio.
​
placeholder
string
Texto de placeholder para o campo no playground.
​
children
string
Descrição do parâmetro (com suporte a Markdown).

​
Campo de resposta

O componente <ResponseField> define os valores de retorno de uma API.
​
response
string
required
Exemplo de um campo de resposta
<ResponseField name="response" type="string" required>
  Exemplo de um campo de resposta
</ResponseField>

​
Propriedades

​
name
string
required
O nome do valor da resposta.
​
type
string
required
Tipo esperado do valor da resposta. Pode ser qualquer string arbitrária.
​
default
string
O valor padrão.
​
required
boolean
Indica se a resposta é obrigatória.
​
deprecated
boolean
Indica se um campo está obsoleto.
​
pre
string[]
Rótulos exibidos antes do nome do campo.
​
post
string[]
Rótulos exibidos após o nome do campo.