Aller au contenu
Mintlify
Mintlify
Composants

Champs de réponse

Documentez les champs de réponse d'API avec le composant ResponseField, les annotations de type, les descriptions et les indicateurs obligatoire ou facultatif.

Utilisez le composant <ResponseField> pour définir les valeurs de retour d’une API. De nombreuses documentations utilisent également <ResponseField> sur les pages lorsque vous devez lister les types de certains éléments.

responsestringrequired

Exemple de champ de réponse

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

Props

namestringrequired

Nom de la valeur de réponse.

typestringrequired

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

defaultstring

Valeur par défaut.

requiredboolean

Afficher « required » à côté du nom du champ.

deprecatedboolean

Indique 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

Response Field Example
<ResponseField name="response" type="string" required>
  Exemple de champ de réponse
</ResponseField>
Ctrl+I
Response Field Example
<ResponseField name="response" type="string" required>
  Exemple de champ de réponse
</ResponseField>