Passer au contenu principal
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.

​
Migration via la CLI

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

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.
Validez votre fichier OpenAPI à l’aide du Swagger Editor ou de la CLI Mint.
2

Installez la CLI Mint

Si nécessaire, installez ou mettez à jour la CLI Mint.
3

Exécutez la commande de migration.

mint migrate-mdx

​
Étapes de migration manuelle

1

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 pour plus de détails.Pour tout endpoint que vous souhaitez exclure de votre documentation, ajoutez l’extension x-hidden à cet endpoint.
Validez votre fichier OpenAPI à l’aide du Swagger Editor ou de la CLI Mint.
2

Mettez à jour votre structure de navigation.

Remplacez les références de pages MDX par des endpoints OpenAPI dans votre docs.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"
      ]
    }
  ]
}
3

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.
Vous pouvez personnaliser l’affichage de votre documentation API dans la navigation.
Combinez des pages d’API générées automatiquement avec d’autres pages : 
"navigation": {
  "groups": [
    {
      "group": "Référence de l’API",
      "openapi": "openapi.json",
      "pages": [
        "api/overview",
        "GET /users",
        "POST /users", 
        "api/authentication"
      ]
    }
  ]
}

​
Plusieurs versions d’API

Organisez différentes versions d’API à l’aide d’onglets ou de groupes : 
"navigation": {
  "tabs": [
    {
      "tab": "API v1",
      "openapi": "specs/v1.json"
    },
    {
      "tab": "API v2", 
      "openapi": "specs/v2.json"
    }
  ]
}

​
Quand utiliser des pages MDX individuelles

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.