Campos

Os campos ajudam a documentar parâmetros de API e campos de resposta em um formato claro e consistente.

Uso

<ParamField query="limit" type="number" default={10}>
  Maximum number of results to return.
</ParamField>

ParamField

Use ParamField para documentar parâmetros de solicitação da API. Especifique a localização do parâmetro usando um destes valores: body, query, path ou header.

user_idstringrequired

O identificador exclusivo do usuário.

limitnumberdefault: 10

Número máximo de resultados a retornar.

Authorizationstringrequired

Token Bearer para autenticação.

<ParamField body="user_id" type="string" required>
  The unique identifier for the user.
</ParamField>

<ParamField query="limit" type="number" default={10}>
  Maximum number of results to return.
</ParamField>

<ParamField header="Authorization" type="string" required>
  Bearer token for authentication.
</ParamField>

Parâmetros de caminho

idstringrequired

Identificador do recurso no caminho da URL.

<ParamField path="id" type="string" required>
  Resource identifier in the URL path.
</ParamField>

Propriedades de ParamField

string

Nome do parâmetro para parâmetros do corpo.

string

Nome do parâmetro para parâmetros da string de consulta.

string

Nome do parâmetro para parâmetros do caminho da URL.

string

Nome do parâmetro para parâmetros do cabeçalho.

string

Tipo de dados (string, number, boolean, array, object).

boolean

Exibe um selo "required".

string | number | boolean

Valor padrão quando não fornecido.

ResponseField

Use ResponseField para documentar propriedades da resposta da API.

idstringrequired

Identificador exclusivo do recurso.

created_atstring

Carimbo de data e hora ISO 8601 de quando o recurso foi criado.

statusstringdefault: pending

Status atual da solicitação.

<ResponseField name="id" type="string" required>
  Unique identifier for the resource.
</ResponseField>

<ResponseField name="created_at" type="string">
  ISO 8601 timestamp of when the resource was created.
</ResponseField>

<ResponseField name="status" type="string" default="pending">
  Current status of the request.
</ResponseField>

Campos obsoletos

Marque os campos como obsoletos para indicar que serão removidos em uma versão futura:

legacy_idnumberdeprecated

Use id em vez disso. Este campo será removido na v2.

<ResponseField name="legacy_id" type="number" deprecated>
  Use `id` instead. This field will be removed in v2.
</ResponseField>

Rótulos

Adicione contexto com os rótulos pre e post:

optionalwebhook_urlv2.1+string

URL para receber notificações de Webhook.

<ResponseField name="webhook_url" type="string" pre={["optional"]} post={["v2.1+"]}>
  URL to receive webhook notifications.
</ResponseField>

Objetos aninhados

Combine com Expandable para documentar propriedades de objetos aninhados:

userobject

O usuário que criou o recurso.

<ResponseField name="user" type="object">
  The user who created the resource.
  <Expandable title="user properties">
    <ResponseField name="id" type="string" required>
      User's unique identifier.
    </ResponseField>
    <ResponseField name="email" type="string" required>
      User's email address.
    </ResponseField>
    <ResponseField name="name" type="string">
      User's display name.
    </ResponseField>
</Expandable>
</ResponseField>

Propriedades de ResponseField

stringrequired

Nome do campo.

string

Tipo de dados.

boolean

Exibe um selo "required".

boolean

Exibe o campo como obsoleto com texto tachado.

string | number | boolean

Valor padrão.

string[]

Rótulos exibidos antes do nome do campo.

string[]

Rótulos exibidos depois do nome do campo.

O que vem a seguir?

Visão geral dos componentes

Browse all available components

Noções básicas de MDX

Learn how to use components in MDX