Jamdesk Documentation logo

Campos

Documente parâmetros de API e campos de resposta com os componentes ParamField e ResponseField, incluindo tipos, valores padrão e objetos aninhados.

Os campos documentam parâmetros de API e campos de resposta em um formato consistente.

Uso

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

ParamField

Use ParamField para documentar parâmetros de requisição da API. Defina a localização do parâmetro com body, query, path ou header.

user_idstringrequired

O identificador único 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 de corpo.

string

Nome do parâmetro para parâmetros de query string.

string

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

string

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

string

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

boolean

Exibe um selo "required".

string | number | boolean

Valor padrão quando não informado.

ResponseField

Use ResponseField para documentar propriedades de resposta da API.

idstringrequired

Identificador único do recurso.

created_atstring

Timestamp ISO 8601 de quando o recurso foi criado.

statusstringdefault: pending

Status atual da requisiçã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 um campo que será removido em uma versão futura como deprecated:

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

Aninhe campos dentro de Expandable para documentar propriedades de objetos:

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 dado.

boolean

Exibe um selo "required".

boolean

Exibe o campo como descontinuado, com texto riscado.

string | number | boolean

Valor padrão.

string[]

Rótulos exibidos antes do nome do campo.

string[]

Rótulos exibidos após o nome do campo.

O que vem a seguir?

Visão geral dos componentes

Explore todos os componentes disponíveis

Fundamentos de MDX

Aprenda a usar componentes em MDX