> ## 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.

# Migration des pages API MDX vers la navigation OpenAPI

> Passer de pages MDX d’endpoint individuelles à une génération OpenAPI automatisée avec une navigation flexible

Si vous utilisez actuellement des pages `MDX` distinctes pour vos endpoints d’API, vous pouvez migrer vers l’autogénération de pages à partir de votre spécification OpenAPI, tout en conservant la possibilité de personnaliser chaque page. Cela peut vous aider à réduire le nombre de fichiers à maintenir et à améliorer la cohérence de votre documentation API.

Vous pouvez définir des métadonnées et du contenu pour chaque endpoint dans votre spécification OpenAPI et placer les endpoints où vous le souhaitez dans votre navigation.

<div id="cli-migration">
  ## Migration via la CLI
</div>

La commande `mint migrate-mdx` est la méthode recommandée pour migrer des pages d’endpoint MDX vers des pages générées automatiquement.

Cette commande :

* Analyse la structure de navigation de votre `docs.json`.
* Identifie les pages MDX qui génèrent des pages d’endpoint OpenAPI.
* Extrait le contenu des fichiers MDX et le déplace vers l’extension `x-mint` dans votre spécification OpenAPI.
* Met à jour votre `docs.json` pour référencer directement les endpoints OpenAPI au lieu des fichiers MDX.
* Supprime les fichiers d’endpoint MDX d’origine.

<Info>
  Si vous avez déjà `x-mint` défini pour un endpoint et que vous avez également une page MDX avec du contenu pour ce même endpoint, le contenu MDX remplacera les paramètres `x-mint` existants.

  Si vous avez plusieurs pages MDX pour le même endpoint avec des contenus différents, le script utilisera le contenu de la page qui apparaît en dernier dans votre `docs.json`.

  L’outil de migration ne permet pas d’afficher un aperçu des changements avant de les appliquer.
</Info>

<Steps>
  <Step title="Préparez votre spécification OpenAPI.">
    Assurez-vous que votre spécification OpenAPI est valide et inclut tous les endpoints que vous souhaitez documenter.

    Toutes les pages MDX que vous souhaitez migrer doivent avoir le frontmatter `openapi:` faisant référence à un endpoint.

    <Tip>
      Validez votre fichier OpenAPI à l’aide du [Swagger Editor](https://editor.swagger.io/) ou de la [CLI Mint](https://www.npmjs.com/package/mint).
    </Tip>
  </Step>

  <Step title="Installez la CLI Mint">
    Si nécessaire, installez ou mettez à jour la [CLI Mint](/fr/installation).
  </Step>

  <Step title="Exécutez la commande de migration.">
    ```bash
    mint migrate-mdx
    ```
  </Step>
</Steps>

<div id="manual-migration-steps">
  ## Étapes de migration manuelle
</div>

<Steps>
  <Step title="Préparez votre spécification OpenAPI.">
    Assurez-vous que votre spécification OpenAPI est valide et inclut tous les endpoints que vous souhaitez documenter.

    Pour tout endpoint dont vous souhaitez personnaliser les métadonnées ou le contenu, ajoutez l’extension `x-mint` à cet endpoint. Voir [extension x-mint](/fr/api-playground/openapi-setup#x-mint-extension) pour plus de détails.

    Pour tout endpoint que vous souhaitez exclure de votre documentation, ajoutez l’extension `x-hidden` à cet endpoint.

    <Info>
      Validez votre fichier OpenAPI à l’aide du [Swagger Editor](https://editor.swagger.io/) ou de la [CLI Mint](https://www.npmjs.com/package/mint).
    </Info>
  </Step>

  <Step title="Mettez à jour votre structure de navigation.">
    Remplacez les références de pages `MDX` par des endpoints OpenAPI dans votre `docs.json`.

    ```json
    "navigation": {
      "groups": [
        {
          "group": "API Reference",
          "openapi": "/path/to/openapi.json",
          "pages": [
            "overview",
            "authentication",
            "introduction",
            "GET /health",
            "quickstart", 
            "POST /users",
            "GET /users/{id}",
            "advanced-features"
          ]
        }
      ]
    }
    ```
  </Step>

  <Step title="Supprimez les anciens fichiers MDX.">
    Après avoir vérifié que votre nouvelle navigation fonctionne correctement, supprimez les fichiers d’endpoint `MDX` dont vous n’avez plus besoin.
  </Step>
</Steps>

<div id="navigation-patterns">
  ## Modèles de navigation
</div>

Vous pouvez personnaliser l’affichage de votre documentation API dans la navigation.

<div id="mixed-content-navigation">
  ### Navigation mixte
</div>

Combinez des pages d’API générées automatiquement avec d’autres pages :

```json
"navigation": {
  "groups": [
    {
      "group": "Référence de l’API",
      "openapi": "openapi.json",
      "pages": [
        "api/overview",
        "GET /users",
        "POST /users", 
        "api/authentication"
      ]
    }
  ]
}
```

<div id="multiple-api-versions">
  ### Plusieurs versions d’API
</div>

Organisez différentes versions d’API à l’aide d’onglets ou de groupes :

```json
"navigation": {
  "tabs": [
    {
      "tab": "API v1",
      "openapi": "specs/v1.json"
    },
    {
      "tab": "API v2", 
      "openapi": "specs/v2.json"
    }
  ]
}
```

<div id="when-to-use-individual-mdx-pages">
  ## Quand utiliser des pages `MDX` individuelles
</div>

Envisagez de conserver des pages `MDX` individuelles lorsque vous avez besoin de :

* Contenu fortement personnalisé par point de terminaison, comme des composants React ou des exemples détaillés.
* Mises en page spécifiques.
* Approches de documentation expérimentales pour certains points de terminaison.

Pour la plupart des cas d’usage, la navigation OpenAPI offre une meilleure maintenabilité et davantage de cohérence.