Générer une spécification OpenAPI

Le proxy de développement vous permet de générer une spécification OpenAPI à partir des requêtes et réponses d’API interceptées. À l’aide du proxy de développement, vous pouvez rapidement créer une spécification OpenAPI pour une API existante et tirer parti des outils qui prennent en charge OpenAPI.

Pour générer une spécification OpenAPI à l’aide du proxy de développement :

1. Dans le fichier de configuration, activez le OpenApiSpecGeneratorPlugin plug-in :

   {
     "plugins": [
       {
         "name": "OpenApiSpecGeneratorPlugin",
         "enabled": true,
         "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll"
       }
     ]
     // [...] shortened for brevity
   }
   

2. Dans le fichier de configuration, dans la liste des URL à surveiller, ajoutez l’URL de l’API pour laquelle vous souhaitez générer une spécification OpenAPI :

   { 
     "urlsToWatch": [
       "https://api.example.com/*",
     ]
     // [...] shortened for brevity
   }
   

   Conseil

   Pour créer de meilleures spécifications OpenAPI, envisagez d’utiliser un modèle de langage local avec le proxy de développement. Pour plus d’informations, consultez Utiliser un modèle de langue locale.

3. Démarrez le proxy de développement :

   devproxy
   

4. Démarrer l’enregistrement des demandes en appuyant sur r

5. Effectuer les demandes que vous souhaitez inclure dans la spécification OpenAPI

6. Arrêter l’enregistrement des demandes en appuyant sur s

7. Le proxy de développement génère une spécification OpenAPI et l’enregistre dans un fichier dans le répertoire actif. Le proxy de développement nomme le fichier après le nom d’hôte de l’API suivi de la date et de l’heure actuelles, par exemple : api.example.com-20231219091700.json.