Migrer les pages d’API MDX vers la navigation OpenAPI

Migrez vos pages d’API rédigées manuellement en MDX vers une documentation générée automatiquement à partir d’OpenAPI, avec navigation flexible et regroupement.

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

Vous pouvez définir les champs metadata et content pour chaque endpoint dans votre spécification OpenAPI, et organiser les endpoints où vous le souhaitez dans votre navigation.

​

Étapes de migration

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 chaque endpoint pour lequel vous souhaitez personnaliser les métadonnées ou le contenu, ajoutez l’extension x-mint à l’endpoint. Consultez l’extension x-mint pour plus de détails.

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

   Validez votre fichier OpenAPI à l’aide de Swagger Editor ou de l’interface en ligne de commande (CLI) Mint.

2. Mettez à jour la structure de votre navigation.

   Remplacez les références de pages MDX par des endpoints OpenAPI dans votre docs.json.

   "navigation": {
     "groups": [
       {
         "group": "Référence d’API",
         "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 MDX correspondant aux endpoints dont vous n’avez plus besoin.

​

Modèles de navigation

Vous pouvez personnaliser la manière dont la documentation de votre API apparaît dans votre navigation.

​

Navigation à contenu mixte

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

"navigation": {
  "groups": [
    {
      "group": "Référence 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 groups :

"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 très personnalisé et volumineux par endpoint, comme des composants React ou des exemples détaillés.
• Mises en page uniques.
• Approches de documentation expérimentales pour des endpoints spécifiques.

Pour la plupart des cas d’utilisation, la navigation OpenAPI offre une meilleure maintenabilité et une plus grande cohérence.