Een OpenAPI-specificatie genereren

In één oogopslag
Doel: Een OpenAPI-specificatie maken op basis van onderschepte API-aanvragen
Tijd: 10 minuten
Plugins:OpenApiSpecGeneratorPlugin
Vereisten:Dev Proxy instellen

Met Dev Proxy kunt u een OpenAPI-specificatie genereren op basis van de onderschepte API-aanvragen en -antwoorden. Met behulp van Dev Proxy kunt u snel een OpenAPI-specificatie maken voor een bestaande API en profiteren van de hulpprogramma's die OpenAPI ondersteunen.

Een OpenAPI-specificatie genereren met behulp van Dev Proxy:

1. Schakel in het configuratiebestand de OpenApiSpecGeneratorPlugin invoegtoepassing in:

   Bestand: devproxyrc.json

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

2. Voeg in het configuratiebestand toe aan de lijst van te volgen URL's de URL van de API waarvoor u een OpenAPI-specificatie wilt genereren.

   Bestand: devproxyrc.json

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

   Tip

   Als u betere OpenAPI-specificaties wilt maken, kunt u overwegen een lokaal taalmodel te gebruiken met Dev Proxy. Zie Een lokaal taalmodel gebruiken voor meer informatie.

3. Dev Proxy starten:

   devproxy
   

4. Begin met het opnemen van aanvragen door op r

5. Voer de aanvragen uit die u wilt opnemen in de OpenAPI-specificatie

6. Opnameverzoeken stoppen door op te drukken s

7. Dev Proxy genereert een OpenAPI-specificatie en slaat deze op in een bestand in de huidige map. Dev Proxy noemt het bestand na de hostnaam van de API, gevolgd door de huidige datum en tijd, bijvoorbeeld: api.example.com-20231219091700.json

Zie ook

• OpenApiSpecGeneratorPlugin - Volledige verwijzing
• Lokaal taalmodel gebruiken - Gegenereerde specificaties verbeteren
• Wat is een OpenAPI-specificatie - Concepten
• Woordenlijst - Terminologie voor dev-proxy