Passer au contenu principal
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.
​
response
string
requis
Exemple de champ de réponse
<ResponseField name="response" type="string" required>
  Exemple de champ de réponse
</ResponseField>

​
Props

​
name
string
requis
Nom de la valeur de réponse.
​
type
string
requis
Type attendu de la valeur de réponse — peut être n’importe quelle chaîne.
​
default
string
Valeur par défaut.
​
required
boolean
Afficher « required » à côté du nom du champ.
​
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
<ResponseField name="response" type="string" required>
  Exemple de champ de réponse
</ResponseField>