Champs

Définissez les paramètres de vos références d’API ou de SDK

Utilisez des champs pour documenter les paramètres et les réponses d’une API. Il existe deux types de champs : les champs de paramètres et les champs de réponse.

​

Champ de paramètre

Le composant <ParamField> sert à définir des paramètres pour vos API ou SDK. L’ajout d’un ParamField ajoute automatiquement un bac à sable d’API.

param · string · requis

Un exemple de champ de paramètre

<ParamField path="param" type="string" required>
  Un exemple de champ de paramètre
</ParamField>

​

Propriétés

query, path, body, or header · string

Indique si le paramètre est de type query, path, body ou header. Suivi du nom du paramètre.

type · string

Type attendu pour la valeur du paramètre.

Prend en charge number, string, boolean, object.

Les tableaux peuvent être définis à l’aide du suffixe []. Par exemple : string[].

required · boolean

Indique si le paramètre est requis.

deprecated · boolean

Indique si le paramètre est obsolète.

default · any

Valeur par défaut utilisée lorsque la valeur de la requête est vide.

placeholder · string

Texte indicatif pour le champ de saisie dans l’aire de test.

children · string

Description du paramètre (compatible Markdown).

​

Champ de réponse

Le composant <ResponseField> définit les valeurs de retour d’une API.

response · string · requis

Un exemple de champ de réponse

<ResponseField name="response" type="string" required>
  Un exemple de champ de réponse
</ResponseField>

​

Propriétés

name · string · requis

Le nom de la valeur de la réponse.

type · string · requis

Type attendu de la valeur de la réponse. Peut être n’importe quelle chaîne arbitraire.

default · string

Valeur par défaut.

required · boolean

Indique si la réponse est obligatoire.

deprecated · boolean

Indique si un champ est obsolète.

pre · string[]

Labels affichés avant le nom du champ.

post · string[]

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