Playground

Permettez aux développeurs de tester des endpoints d’API directement dans votre documentation.

​

Aperçu

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

Voir Déclencher une mise à jour pour un exemple du playground API en action.

Le playground génère des pages interactives pour vos endpoints à partir de votre spécification OpenAPI ou de votre schéma AsyncAPI. Si vous modifiez votre API, il met automatiquement à jour les pages concernées.

Nous recommandons de générer votre playground API à partir d’une spécification OpenAPI. Cependant, vous pouvez 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.

​

Premiers pas

1. Ajoutez votre fichier de spécification OpenAPI.

   Validez votre fichier de spécification OpenAPI avec le Swagger Editor ou la commande Mint CLI mint openapi-check <filename>.

   /your-project
     |- docs.json
     |- openapi.json
   

2. Générez les pages des endpoints.

   Mettez à jour votre docs.json pour référencer votre spécification OpenAPI.

   Pour générer automatiquement des pages pour tous les endpoints de votre spécification OpenAPI, ajoutez une propriété openapi à n’importe quel élément de navigation.

   Cet exemple génère une page pour chaque endpoint défini dans openapi.json et organise les pages dans le groupe « Référence API ».

   Generate all endpoint pages

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

   Pour ne générer des pages que pour certains endpoints, énumérez-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’endpoints, ajoutez-les au tableau pages.

   Generate specific endpoint pages

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

​

Personnaliser votre bac à sable

Personnalisez votre bac à sable d’API en définissant les propriétés suivantes dans votre docs.json.

playground · object

Configurations du bac à sable d’API.

Masquer playground

display · "interactive" | "simple" | "none"

Le mode d’affichage du bac à sable d’API.

• "interactive" : Affiche le bac à sable interactif.
• "simple" : Affiche un endpoint copiable sans bac à sable.
• "none" : N’affiche rien.

Valeur par défaut : interactive.

proxy · boolean

Indique s’il faut faire passer les requêtes API via un serveur proxy. Valeur par défaut : true.

examples · object

Configurations pour les exemples d’API générés automatiquement.

Masquer examples

languages · array of string

Langues d’exemples pour les extraits d’API générés automatiquement.

Les langues s’affichent dans l’ordre indiqué.

defaults · "required" | "all"

Indique s’il faut afficher les paramètres optionnels dans les exemples d’API. Valeur par défaut : all.

prefill · boolean

Indique s’il faut préremplir le bac à sable d’API avec des données tirées des exemples de schéma. Lorsque cette option est activée, le bac à sable remplit automatiquement les champs de requête avec des valeurs d’exemple provenant de votre spécification OpenAPI. Valeur par défaut : false.

​

Exemple de configuration

Cet exemple configure l’aire de test de l’API pour être interactive, avec des extraits de code pour cURL, Python et JavaScript. Seuls les paramètres requis sont affichés dans les extraits, et l’aire de test préremplit le corps de la requête avec des valeurs d’exemple.

{
 "api": {
   "playground": {
     "display": "interactive"
   },
   "examples": {
     "languages": ["curl", "python", "javascript"],
     "defaults": "required",
     "prefill": true
   }
 }
}

​

Pages d’endpoint personnalisées

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

Les deux options vous permettent de :

• Personnaliser la metadata de la page
• Ajouter du contenu supplémentaire, comme des exemples
• Contrôler le comportement du playground pour chaque page

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

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

​

Pour aller plus loin

• Configuration OpenAPI pour plus d’informations sur la création de votre document OpenAPI.
• Extension x-mint pour plus d’informations sur la personnalisation des pages de vos endpoints.
• Configuration MDX pour plus d’informations sur la création manuelle de pages de référence d’API individuelles.
• Configuration AsyncAPI pour plus d’informations sur la création de votre schéma AsyncAPI afin de générer des pages de référence WebSocket.