---
title: ParamField
description: Documenter les paramètres de requête — body, query, path et header.
url: https://docs.thally.io/fr/components/param-field
---

# ParamField

Documenter les paramètres de requête — body, query, path et header.

{/* thally:ai-translation locale=fr source-sha=90aca4fdcb5c96249597bd92ce58bd27cbb54a5a79b0191dc349960e0a2533a5 */}
{/* Remove the marker above before manual edits to opt out of automatic refresh. */}

`<ParamField>` affiche une entrée de paramètre structurée pour la documentation des requêtes API. Utilisez les props `body`, `query`, `path` ou `header` pour spécifier l'emplacement du paramètre.

## Exemple

- **name** (string):
  Le nom de l'animal. Doit être entre 1 et 100 caractères.

- **limit** (integer):
  Nombre de résultats à retourner. Le maximum est 100.

- **petId** (string):
  L'identifiant unique de l'animal.

- **Authorization** (string):
  Jeton Bearer pour l'authentification : `Bearer sk-...`

```mdx
<ParamField body name="name" type="string" required>
  The name of the pet.
</ParamField>

<ParamField query name="limit" type="integer" default="20">
  Maximum results to return.
</ParamField>

<ParamField path name="petId" type="string" required>
  The unique identifier.
</ParamField>
```

## Props

| Prop | Type | Description |
|---|---|---|
| `name` | `string` | Nom du paramètre |
| `type` | `string` | Type de données (par ex. `string`, `integer`, `boolean`) |
| `body` | `boolean` | Marque comme paramètre de corps de requête |
| `query` | `boolean` | Marque comme paramètre de chaîne de requête |
| `path` | `boolean` | Marque comme paramètre de chemin |
| `header` | `boolean` | Marque comme en-tête de requête |
| `required` | `boolean` | Affiche un badge « required » |
| `default` | `string` | Valeur par défaut affichée en ligne |