> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify-docs-automation-github-pr-review.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Paramètres d'API

> Configurez les spécifications OpenAPI et AsyncAPI, le playground API, les exemples de code SDK et les paramètres d’authentification dans docs.json.

Utilisez le champ `api` dans `docs.json` pour configurer les spécifications d'API qui génèrent les pages d'API, le playground d'API interactif pour tester les endpoints, et comment générer et afficher les exemples de code.

## Paramètres

### `api`

**Type :** `object`

Définissez tous les paramètres liés à l'API sous la clé `api`.

<ResponseField name="api.openapi" type="string or array or object">
  Fichiers de spécification OpenAPI pour générer des pages de référence d'API. Accepte un chemin ou une URL unique, un tableau de chemins et d'URL, ou un objet spécifiant une source et un répertoire.

  <Expandable title="api.openapi object">
    <ResponseField name="source" type="string">
      URL ou chemin vers votre fichier de spécification OpenAPI. Longueur minimale : 1.
    </ResponseField>

    <ResponseField name="directory" type="string">
      Répertoire dans lequel rechercher les fichiers OpenAPI. N'incluez pas de barre oblique initiale.
    </ResponseField>
  </Expandable>

  <CodeGroup>
    ```json Fichier unique theme={null}
    "openapi": "openapi.json"
    ```

    ```json Fichiers multiples theme={null}
    "openapi": [
      "openapi/v1.json",
      "openapi/v2.json",
      "https://api.example.com/openapi.yaml"
    ]
    ```

    ```json Répertoire theme={null}
    "openapi": {
      "source": "openapi.json",
      "directory": "api-reference"
    }
    ```
  </CodeGroup>
</ResponseField>

<ResponseField name="api.asyncapi" type="string or array or object">
  Fichiers de spécification AsyncAPI pour générer des pages de référence d'API événementielles. Accepte un chemin ou une URL unique, un tableau de chemins et d'URL, ou un objet spécifiant une source et un répertoire.

  <Expandable title="api.asyncapi object">
    <ResponseField name="source" type="string">
      URL ou chemin vers votre fichier de spécification AsyncAPI. Longueur minimale : 1.
    </ResponseField>

    <ResponseField name="directory" type="string">
      Répertoire dans lequel rechercher les fichiers AsyncAPI. N'incluez pas de barre oblique initiale.
    </ResponseField>
  </Expandable>

  <CodeGroup>
    ```json Fichier unique theme={null}
    "asyncapi": "asyncapi.json"
    ```

    ```json Fichiers multiples theme={null}
    "asyncapi": [
      "asyncapi/events.yaml",
      "asyncapi/webhooks.yaml"
    ]
    ```

    ```json Répertoire theme={null}
    "asyncapi": {
      "source": "asyncapi.json",
      "directory": "websockets"
    }
    ```
  </CodeGroup>
</ResponseField>

<ResponseField name="api.playground" type="object">
  Paramètres du playground d'API interactif.

  <Expandable title="api.playground">
    <ResponseField name="display" type="&#x22;interactive&#x22; | &#x22;simple&#x22; | &#x22;none&#x22; | &#x22;auth&#x22;">
      Le mode d'affichage du playground. Valeur par défaut : `interactive`.

      * `interactive` — Playground interactif complet avec constructeur de requêtes
      * `simple` — Vue simplifiée sans le constructeur de requêtes
      * `none` — Masquer complètement le playground
      * `auth` — Afficher le playground uniquement aux utilisateurs authentifiés
    </ResponseField>

    <ResponseField name="proxy" type="boolean">
      Indique s'il faut router les requêtes d'API via un serveur proxy. Valeur par défaut : `true`.
    </ResponseField>

    <ResponseField name="credentials" type="boolean">
      Indique s'il faut inclure les cookies et les en-têtes d'authentification pour les requêtes cross-origin lorsque `proxy` est `false`. Valeur par défaut : `false`. N'a aucun effet lorsque `proxy` est `true`.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="api.params" type="object">
  Paramètres d'affichage des paramètres d'API.

  <Expandable title="api.params">
    <ResponseField name="expanded" type="&#x22;all&#x22; | &#x22;closed&#x22;">
      Indique s'il faut développer tous les paramètres par défaut. Valeur par défaut : `closed`.
    </ResponseField>

    <ResponseField name="post" type="array of string">
      Clés de champs de la spécification OpenAPI à faire apparaître sous forme de pastilles post à côté du nom de chaque paramètre dans les pages de référence d'API et dans le playground. Pour chaque clé que vous listez, Mintlify lit la valeur depuis le schéma et l'affiche sous forme de pastille :

      * Les valeurs de chaîne sont affichées telles quelles.
      * `true` affiche le nom de la clé comme libellé de la pastille. `false`, `null` et les chaînes vides n'affichent rien.
      * Les valeurs numériques sont affichées sous forme de chaîne.
      * Les tableaux de chaînes ou de nombres affichent une pastille par élément.
      * Les objets et les autres valeurs sont ignorés.

      Utilisez ceci pour exposer des champs OpenAPI personnalisés — tels que `x-internal`, `nullable` ou des extensions de fournisseur — sous forme d'annotations visuelles sur chaque paramètre, sans configuration propriété par propriété.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="api.url" type="&#x22;full&#x22;">
  Mode d'affichage de l'URL de base dans l'en-tête de l'endpoint. Définissez sur `full` pour toujours afficher l'URL de base complète sur chaque page d'endpoint. Par défaut, l'URL de base n'est affichée que lorsqu'il y a plusieurs URL de base parmi lesquelles choisir.
</ResponseField>

<ResponseField name="api.examples" type="object">
  Paramètres pour les exemples de code d'API générés automatiquement.

  <Expandable title="api.examples">
    <ResponseField name="languages" type="array of string">
      Langages pour les extraits de code générés automatiquement. Voir [langages pris en charge](/fr/api-playground/overview#all-supported-languages) pour la liste complète des langages et alias disponibles.
    </ResponseField>

    <ResponseField name="defaults" type="&#x22;required&#x22; | &#x22;all&#x22;">
      Indique s'il faut inclure les paramètres facultatifs dans les exemples générés. Valeur par défaut : `all`.
    </ResponseField>

    <ResponseField name="prefill" type="boolean">
      Indique s'il faut préremplir le playground avec les valeurs d'exemple de votre spécification OpenAPI. Valeur par défaut : `false`.
    </ResponseField>

    <ResponseField name="autogenerate" type="boolean">
      Indique s'il faut générer des exemples de code pour les endpoints à partir de votre spécification d'API. Valeur par défaut : `true`. Lorsque défini sur `false`, seuls les exemples de code écrits manuellement (à partir de `x-codeSamples` dans OpenAPI ou des composants `<RequestExample>` dans MDX) apparaissent dans le playground.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="api.mdx" type="object">
  Paramètres pour les pages d'API construites à partir de fichiers MDX plutôt que de spécifications OpenAPI.

  <Expandable title="api.mdx">
    <ResponseField name="auth" type="object">
      Configuration d'authentification pour les requêtes d'API basées sur MDX.

      <Expandable title="auth">
        <ResponseField name="method" type="&#x22;bearer&#x22; | &#x22;basic&#x22; | &#x22;key&#x22; | &#x22;cobo&#x22;">
          Méthode d'authentification pour les requêtes d'API.
        </ResponseField>

        <ResponseField name="name" type="string">
          Nom du paramètre d'authentification pour les requêtes d'API.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="server" type="string or array">
      URL de base ajoutée en préfixe aux chemins relatifs dans les champs frontmatter `api` au niveau de la page. Non utilisée lorsque le frontmatter contient une URL complète.
    </ResponseField>
  </Expandable>
</ResponseField>

## Exemple

```json docs.json theme={null}
{
  "api": {
    "openapi": ["openapi/v1.json", "openapi/v2.json"],
    "playground": {
      "display": "interactive"
    },
    "params": {
      "expanded": "all",
      "post": ["nullable", "x-internal"]
    },
    "url": "full",
    "examples": {
      "languages": ["curl", "python", "javascript", "go"],
      "defaults": "required",
      "prefill": true,
      "autogenerate": true
    }
  }
}
```