Passer au contenu principal
<ResponseField name="response" type="string" required>
  Un exemple de champ de réponse
</ResponseField>
Le composant <ResponseField> permet de définir les valeurs de retour d’une API. De nombreuses documentations l’utilisent également sur des pages lorsqu’il faut lister des types.
​
response
string
required
Un exemple de champ de réponse
<ResponseField name="response" type="string" required>
  Un exemple de champ de réponse
</ResponseField>

​
Props

​
name
string
required
Le nom de la valeur de réponse.
​
type
string
required
Type attendu de la valeur de réponse — il peut s’agir de n’importe quelle chaîne.
​
default
string
La valeur par défaut.
​
required
boolean
Afficher « required » à côté du nom du champ.
​
deprecated
boolean
Indique si un champ est « deprecated » ou non.
​
pre
string[]
Libellés affichés avant le nom du champ
​
post
string[]
Libellés affichés après le nom du champ
<ResponseField name="response" type="string" required>
  Un exemple de champ de réponse
</ResponseField>
⌘I