Campi

I campi consentono di documentare i parametri API e i campi della risposta in un formato chiaro e coerente.

Utilizzo

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

ParamField

Usa ParamField per documentare i parametri della richiesta API. Specifica la posizione del parametro usando uno tra body, query, path o header.

user_idstringrequired

L'identificatore univoco dell'utente.

limitnumberdefault: 10

Numero massimo di risultati da restituire.

Authorizationstringrequired

Token Bearer per l'autenticazione.

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

Parametri del percorso

idstringrequired

Identificatore della risorsa nel percorso dell'URL.

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

Proprietà di ParamField

string

Nome del parametro per i parametri del body.

string

Nome del parametro per i parametri della stringa di query.

string

Nome del parametro per i parametri del percorso dell'URL.

string

Nome del parametro per i parametri dell'header.

string

Tipo di dati (string, number, boolean, array, object).

boolean

Mostra un badge "required".

string | number | boolean

Valore predefinito quando non viene fornito.

ResponseField

Usa ResponseField per documentare le proprietà della risposta API.

idstringrequired

Identificatore univoco della risorsa.

created_atstring

Timestamp ISO 8601 della creazione della risorsa.

statusstringdefault: pending

Stato attuale della richiesta.

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

Campi obsoleti

Contrassegna i campi come obsoleti per indicare che verranno rimossi in una versione futura:

legacy_idnumberdeprecated

Usa id al suo posto. Questo campo verrà rimosso nella versione v2.

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

Etichette

Aggiungi contesto con le etichette pre e post:

optionalwebhook_urlv2.1+string

URL per ricevere le notifiche del Webhook.

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

Oggetti nidificati

Combina ResponseField con Expandable per documentare le proprietà degli oggetti nidificati:

userobject

L'utente che ha creato la risorsa.

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

Proprietà di ResponseField

stringrequired

Nome del campo.

string

Tipo di dati.

boolean

Mostra un badge "required".

boolean

Mostra il campo come obsoleto con testo barrato.

string | number | boolean

Valore predefinito.

string[]

Etichette visualizzate prima del nome del campo.

string[]

Etichette visualizzate dopo il nome del campo.

Cosa fare dopo

Panoramica dei componenti

Esplora tutti i componenti disponibili

Nozioni di base su MDX

Scopri come usare i componenti in MDX