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

​
Champ de paramètre

Utilisez le composant <ParamField> pour 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
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 une requête, un chemin, un corps ou un en-tête. Puis le nom du paramètre.
​
type
string
Type attendu pour la valeur du paramètre.Prend en charge number, string, boolean, object.Définissez les tableaux avec le suffixe []. Par exemple string[].
​
required
boolean
Indique si vous exigez le paramètre.
​
deprecated
boolean
Indique si vous avez marqué le paramètre comme obsolète.
​
default
any
Valeur par défaut utilisée lorsque la valeur de la requête est vide.
​
placeholder
string
Texte de remplacement pour le champ dans l’aire d’essai.
​
children
string
Description du paramètre (Markdown activé).

​
Champ de réponse

Le composant <ResponseField> définit les valeurs de retour d’une API.
​
response
string
requis
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 réponse.
​
type
string
requis
Type attendu pour la valeur de réponse. Il peut s’agir de n’importe quelle chaîne arbitraire.
​
default
string
La valeur par défaut.
​
required
boolean
Indique si vous exigez la réponse.
​
deprecated
boolean
Indique si vous avez marqué un champ comme obsolète.
​
pre
string[]
Étiquettes qui apparaissent avant le nom du champ.
​
post
string[]
Étiquettes qui apparaissent après le nom du champ.