> ## Documentation Index
> Fetch the complete documentation index at: https://omer-914cc1c6.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Champs

> Définissez les paramètres de vos références d’API ou de SDK

Utilisez des champs pour documenter les paramètres et les réponses d’une 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>
  Un 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 de type query, path, body ou header. Suivi du
  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 à l'aide du 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 indicatif pour le champ de saisie dans l’aire de test.
</ParamField>

<ParamField body="children" type="string">
  Description du paramètre (compatible Markdown).
</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>
  Un 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 la réponse.
</ResponseField>

<ResponseField name="type" type="string" required>
  Type attendu de la valeur de la réponse. Peut être n’importe quelle chaîne arbitraire.
</ResponseField>

<ResponseField name="default" type="string">
  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[]">
  Labels affichés avant le nom du champ.
</ResponseField>

<ResponseField name="post" type="string[]">
  Labels affichés après le nom du champ.
</ResponseField>