mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
2ccd573b95
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
109 lines
3.1 KiB
Plaintext
109 lines
3.1 KiB
Plaintext
---
|
||
title: "Champs"
|
||
description: "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."
|
||
keywords: ["ParamField", "ResponseField", "request parameters", "response documentation"]
|
||
boost: 3
|
||
---
|
||
|
||
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.
|
||
|
||
<div id="parameter-field">
|
||
## Champ de paramètre
|
||
</div>
|
||
|
||
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](/fr/api-playground/overview).
|
||
|
||
<ParamField path="param" type="string" required>
|
||
Exemple de champ de paramètre
|
||
</ParamField>
|
||
|
||
```mdx
|
||
<ParamField path="param" type="string" required>
|
||
Un exemple de champ de paramètre
|
||
</ParamField>
|
||
```
|
||
|
||
<div id="properties">
|
||
### Propriétés
|
||
</div>
|
||
|
||
<ParamField body="query, path, body, or header" type="string">
|
||
Indique si le paramètre est une requête, un chemin, un corps ou un en-tête. Puis le
|
||
nom du paramètre.
|
||
</ParamField>
|
||
|
||
<ParamField body="type" type="string">
|
||
Type attendu pour la valeur du paramètre.
|
||
|
||
Prend en charge `number`, `string`, `boolean`, `object`.
|
||
|
||
Définissez les tableaux avec le suffixe `[]`. Par exemple `string[]`.
|
||
</ParamField>
|
||
|
||
<ParamField body="required" type="boolean">
|
||
Indique si vous exigez le paramètre.
|
||
</ParamField>
|
||
|
||
<ParamField body="deprecated" type="boolean">
|
||
Indique si vous avez marqué le paramètre comme obsolète.
|
||
</ParamField>
|
||
|
||
<ParamField body="default" type="any">
|
||
Valeur par défaut utilisée lorsque la valeur de la requête est vide.
|
||
</ParamField>
|
||
|
||
<ParamField body="placeholder" type="string">
|
||
Texte de remplacement pour le champ dans l’aire d’essai.
|
||
</ParamField>
|
||
|
||
<ParamField body="children" type="string">
|
||
Description du paramètre (Markdown activé).
|
||
</ParamField>
|
||
|
||
<div id="response-field">
|
||
## Champ de réponse
|
||
</div>
|
||
|
||
Le composant `<ResponseField>` définit les valeurs de retour d’une API.
|
||
|
||
<ResponseField name="response" type="string" required>
|
||
Exemple de champ de réponse
|
||
</ResponseField>
|
||
|
||
```mdx
|
||
<ResponseField name="response" type="string" required>
|
||
Un exemple de champ de réponse
|
||
</ResponseField>
|
||
```
|
||
|
||
<div id="properties">
|
||
### Propriétés
|
||
</div>
|
||
|
||
<ResponseField name="name" type="string" required>
|
||
Le nom de la valeur de réponse.
|
||
</ResponseField>
|
||
|
||
<ResponseField name="type" type="string" required>
|
||
Type attendu pour la valeur de réponse. Il peut s’agir de n’importe quelle chaîne arbitraire.
|
||
</ResponseField>
|
||
|
||
<ResponseField name="default" type="string">
|
||
La valeur par défaut.
|
||
</ResponseField>
|
||
|
||
<ResponseField name="required" type="boolean">
|
||
Indique si vous exigez la réponse.
|
||
</ResponseField>
|
||
|
||
<ResponseField name="deprecated" type="boolean">
|
||
Indique si vous avez marqué un champ comme obsolète.
|
||
</ResponseField>
|
||
|
||
<ResponseField name="pre" type="string[]">
|
||
Étiquettes qui apparaissent avant le nom du champ.
|
||
</ResponseField>
|
||
|
||
<ResponseField name="post" type="string[]">
|
||
Étiquettes qui apparaissent après le nom du champ.
|
||
</ResponseField> |