Champs

Les champs vous permettent de documenter les paramètres API et les champs de réponse dans un format clair et cohérent.

Usage

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

ParamField

Utilisez ParamField pour documenter les paramètres de requête API. Spécifiez l'emplacement du paramètre avec l'une des valeurs suivantes : body, query, path ou header.

user_idstringrequired

L'identifiant unique de l'utilisateur.

limitnumberdefault: 10

Nombre maximum de résultats à retourner.

Authorizationstringrequired

Token Bearer pour l'authentification.

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

Paramètres de chemin

idstringrequired

Identifiant de la ressource dans le chemin URL.

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

Props ParamField

string

Nom du paramètre pour les paramètres de body.

string

Nom du paramètre pour les paramètres de chaîne de requête.

string

Nom du paramètre pour les paramètres de chemin URL.

string

Nom du paramètre pour les paramètres d'en-tête.

string

Type de données (string, number, boolean, array, object).

boolean

Affiche un badge « required ».

string | number | boolean

Valeur par défaut lorsqu'elle n'est pas fournie.

ResponseField

Utilisez ResponseField pour documenter les propriétés de réponse API.

idstringrequired

Identifiant unique de la ressource.

created_atstring

Horodatage ISO 8601 indiquant quand la ressource a été créée.

statusstringdefault: pending

Statut actuel de la requête.

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

Champs dépréciés

Marquez les champs comme dépréciés pour indiquer qu'ils seront supprimés dans une future version :

legacy_idnumberdeprecated

Utilisez id à la place. Ce champ sera supprimé dans la v2.

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

Labels

Ajoutez du contexte avec les labels pre et post :

optionalwebhook_urlv2.1+string

URL pour recevoir les notifications Webhook.

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

Objets imbriqués

Combinez avec Expandable pour documenter les propriétés d'objets imbriqués :

userobject

L'utilisateur qui a créé la ressource.

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

Props ResponseField

stringrequired

Nom du champ.

string

Type de données.

boolean

Affiche un badge « required ».

boolean

Affiche le champ comme déprécié avec une mise en forme barrée.

string | number | boolean

Valeur par défaut.

string[]

Labels affichés avant le nom du champ.

string[]

Labels affichés après le nom du champ.

Et ensuite ?

Vue d'ensemble des composants

Parcourir tous les composants disponibles

Bases MDX

Apprendre à utiliser les composants en MDX