> ## Documentation Index
> Fetch the complete documentation index at: https://wiki.another-horizon.eu/llms.txt
> Use this file to discover all available pages before exploring further.

# Champs

> Documentez les paramètres de requête et de réponse d’une API avec des informations de type.

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>

Le composant `<ParamField>` sert à 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 theme={null}
<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`.

  Les tableaux peuvent être définis avec le suffixe `[]`. Par exemple `string[]`.
</ParamField>

<ParamField body="required" type="boolean">
  Indique si le paramètre est requis.
</ParamField>

<ParamField body="deprecated" type="boolean">
  Indique si le paramètre est 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 theme={null}
<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 la réponse est obligatoire.
</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>