Champs
Utilisez les composants ParamField et ResponseField pour documenter les paramètres de requête et réponse d'API avec types, valeurs par défaut et validation.
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.
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.
paramstringrequiredExemple de champ de paramètre
<ParamField path="param" type="string" required>
Un exemple de champ de paramètre
</ParamField>query, path, body, or headerstringIndique si le paramètre est une requête, un chemin, un corps ou un en-tête. Puis le nom du paramètre.
typestringType attendu pour la valeur du paramètre.
Prend en charge number, string, boolean, object.
Définissez les tableaux avec le suffixe []. Par exemple string[].
requiredbooleanIndique si vous exigez le paramètre.
deprecatedbooleanIndique si vous avez marqué le paramètre comme obsolète.
defaultanyValeur par défaut utilisée lorsque la valeur de la requête est vide.
placeholderstringTexte de remplacement pour le champ dans l’aire d’essai.
childrenstringDescription du paramètre (Markdown activé).
Le composant <ResponseField> définit les valeurs de retour d’une API.
responsestringrequiredExemple de champ de réponse
<ResponseField name="response" type="string" required>
Un exemple de champ de réponse
</ResponseField>namestringrequiredLe nom de la valeur de réponse.
typestringrequiredType attendu pour la valeur de réponse. Il peut s’agir de n’importe quelle chaîne arbitraire.
defaultstringLa valeur par défaut.
requiredbooleanIndique si vous exigez la réponse.
deprecatedbooleanIndique si vous avez marqué un champ comme obsolète.
prestring[]Étiquettes qui apparaissent avant le nom du champ.
poststring[]Étiquettes qui apparaissent après le nom du champ.