> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify-mintlify-add-hello-world-quickstart-48843.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Playground

> Permettez aux utilisateurs d’interagir avec votre API

<div id="overview">
  ## Aperçu
</div>

Le Terrain de jeu API est un environnement interactif qui permet aux utilisateurs de tester et d’explorer vos points de terminaison d’API. Les développeurs peuvent composer des requêtes API, les envoyer et consulter les réponses sans quitter votre documentation.

<Frame>
  <img src="https://mintcdn.com/mintlify-mintlify-add-hello-world-quickstart-48843/jocJo5b89LRoeOR4/images/playground/API-playground-light.png?fit=max&auto=format&n=jocJo5b89LRoeOR4&q=85&s=5ff1379ab70a3f92033c7bf89b492b13" alt="Terrain de jeu API pour le point de terminaison déclenchant une mise à jour." className="block dark:hidden" width="2534" height="1022" data-path="images/playground/API-playground-light.png" />

  <img src="https://mintcdn.com/mintlify-mintlify-add-hello-world-quickstart-48843/jocJo5b89LRoeOR4/images/playground/API-playground-dark.png?fit=max&auto=format&n=jocJo5b89LRoeOR4&q=85&s=8d3261da2c37f727736e9abceca32d97" alt="Terrain de jeu API pour le point de terminaison déclenchant une mise à jour." className="hidden dark:block" width="2534" height="1022" data-path="images/playground/API-playground-dark.png" />
</Frame>

Le terrain de jeu est généré automatiquement à partir de votre spécification OpenAPI ou de votre schéma AsyncAPI, de sorte que toute mise à jour de votre API y est automatiquement reflétée. Vous pouvez également créer manuellement des pages de référence de l’API après avoir défini une URL de base et une méthode d’authentification dans votre `docs.json`.

Nous recommandons de générer votre Terrain de jeu API à partir d’une spécification OpenAPI. Consultez [OpenAPI Setup](/fr/api-playground/openapi-setup) pour plus d’informations sur la création de votre document OpenAPI.

<div id="getting-started">
  ## Pour commencer
</div>

<Steps>
  <Step title="Ajoutez votre fichier de spécification OpenAPI.">
    <Info>
      Vérifiez que votre fichier de spécification OpenAPI est valide avec le [Swagger Editor](https://editor.swagger.io/) ou le [Mint CLI](https://www.npmjs.com/package/mint).
    </Info>

    ```bash {3}
    /your-project
      |- docs.json
      |- openapi.json
    ```
  </Step>

  <Step title="Configurez `docs.json`.">
    Mettez à jour votre `docs.json` pour référencer votre spécification OpenAPI. Ajoutez une propriété `openapi` à tout élément de navigation pour remplir automatiquement votre documentation avec des pages pour chaque endpoint défini dans votre document OpenAPI.

    Cet exemple génère une page pour chaque endpoint défini dans `openapi.json` et les organise sous le groupe « API reference » dans votre navigation.

    ```json
    "navigation": {
      "groups": [
        {
          "group": "API reference",
          "openapi": "openapi.json"
        }
      ]
    }
    ```

    Pour ne générer des pages que pour certains endpoints, listez-les dans la propriété `pages` de l’élément de navigation.

    Cet exemple génère des pages uniquement pour les endpoints `GET /users` et `POST /users`. Pour générer d’autres pages d’endpoint, ajoutez des endpoints supplémentaires au tableau `pages`.

    ```json
    "navigation": {
      "groups": [
          {
            "group": "API reference",
            "openapi": "openapi.json",
            "pages": [
              "GET /users",
              "POST /users"
            ]
          }
      ]
    }
    ```
  </Step>
</Steps>

<div id="customizing-your-playground">
  ## Personnaliser votre terrain de jeu
</div>

Vous pouvez personnaliser votre Terrain de jeu API en définissant les propriétés suivantes dans votre `docs.json`.

<ResponseField name="playground" type="object">
  Configurations du Terrain de jeu API.

  <Expandable title="playground" defaultOpen="True">
    <ResponseField name="display" type="&#x22;interactive&#x22; | &#x22;simple&#x22; | &#x22;none&#x22;">
      Le mode d’affichage du Terrain de jeu API.

      * `"interactive"` : Affiche le terrain de jeu interactif.
      * `"simple"` : Affiche un endpoint copiable sans terrain de jeu.
      * `"none"` : N’affiche rien.

      Par défaut : `interactive`.
    </ResponseField>

    <ResponseField name="proxy" type="boolean" defaultOpen="True">
      Indique s’il faut faire transiter les requêtes API par un serveur proxy. Par défaut : `true`.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="examples" type="object">
  Configurations pour les exemples API générés automatiquement.

  <Expandable title="examples" defaultOpen="True">
    <ResponseField name="languages" type="array of string">
      Langages d’exemple pour les Snippets API générés automatiquement.

      Les langages s’affichent dans l’ordre indiqué.
    </ResponseField>

    <ResponseField name="defaults" type="&#x22;required&#x22; | &#x22;all&#x22;">
      Indique s’il faut afficher les paramètres optionnels dans les exemples API. Par défaut : `all`.
    </ResponseField>
  </Expandable>
</ResponseField>

<div id="example-configuration">
  ### Exemple de configuration
</div>

```json
{
 "api": {
   "playground": {
     "display": "interactif"
   },
   "examples": {
     "languages": ["curl", "python", "javascript"],
     "defaults": "obligatoire"
   }
 }
}
```

Cet exemple configure le Terrain de jeu API pour qu’il soit interactif, avec des Snippets de code d’exemple pour cURL, Python et JavaScript. Seuls les paramètres requis sont affichés dans les Snippets.

<div id="custom-endpoint-pages">
  ### Pages d’endpoints personnalisées
</div>

Lorsque vous avez besoin de plus de contrôle sur votre documentation d’API, utilisez l’extension `x-mint` dans votre spécification OpenAPI ou créez des pages `MDX` distinctes pour vos endpoints.

Ces deux options vous permettent de :

* Personnaliser les métadonnées de page
* Ajouter du contenu supplémentaire, comme des exemples
* Contrôler le comportement du playground par page

L’extension `x-mint` est recommandée afin que l’ensemble de votre documentation d’API soit généré automatiquement à partir de votre spécification OpenAPI et maintenu dans un fichier unique.

Les pages `MDX` individuelles sont recommandées pour les petites API ou lorsque vous souhaitez expérimenter des modifications au cas par cas.

Pour en savoir plus, consultez l’[extension x-mint](/fr/api-playground/openapi-setup#x-mint-extension) et la [configuration MDX](/fr/api-playground/mdx/configuration).

<div id="further-reading">
  ## Pour aller plus loin
</div>

* [Configuration d’AsyncAPI](/fr/api-playground/asyncapi/setup) pour en savoir plus sur la création de votre schéma AsyncAPI afin de générer des pages de référence WebSocket.