mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
3f716a535f
Generated-By: mintlify-agent Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
60 lines
1.7 KiB
Plaintext
60 lines
1.7 KiB
Plaintext
---
|
||
title: "Champs de réponse"
|
||
description: "Documentez les champs de réponse d’une API à l’aide du composant ResponseField avec des annotations de type, des descriptions et des indicateurs obligatoire ou facultatif."
|
||
keywords: ["sortie d’API", "valeurs de retour", "structure de réponse"]
|
||
---
|
||
|
||
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.
|
||
|
||
<ResponseField name="response" type="string" required>
|
||
Exemple de champ de réponse
|
||
</ResponseField>
|
||
|
||
```mdx
|
||
<ResponseField name="response" type="string" required>
|
||
Exemple de champ de réponse
|
||
</ResponseField>
|
||
```
|
||
|
||
|
||
<div id="props">
|
||
## Props
|
||
</div>
|
||
|
||
<ResponseField name="name" type="string" required>
|
||
Nom de la valeur de réponse.
|
||
</ResponseField>
|
||
|
||
<ResponseField name="type" type="string" required>
|
||
Type attendu de la valeur de réponse — peut être n’importe quelle chaîne.
|
||
</ResponseField>
|
||
|
||
<ResponseField name="default" type="string">
|
||
Valeur par défaut.
|
||
</ResponseField>
|
||
|
||
<ResponseField name="required" type="boolean">
|
||
Afficher « required » à côté du nom du champ.
|
||
</ResponseField>
|
||
|
||
<ResponseField name="deprecated" type="boolean">
|
||
Indique si un champ est obsolète.
|
||
</ResponseField>
|
||
|
||
<ResponseField name="pre" type="string[]">
|
||
Étiquettes affichées avant le nom du champ
|
||
</ResponseField>
|
||
|
||
<ResponseField name="post" type="string[]">
|
||
Étiquettes affichées après le nom du champ
|
||
</ResponseField>
|
||
|
||
<RequestExample>
|
||
|
||
```mdx Response Field Example
|
||
<ResponseField name="response" type="string" required>
|
||
Exemple de champ de réponse
|
||
</ResponseField>
|
||
```
|
||
|
||
</RequestExample> |