Generera en OpenAPI-specifikation

Överblick
Mål: Skapa en OpenAPI-specifikation från snappade API-begäranden
Tid: 10 minuter
Plugin-program:OpenApiSpecGeneratorPlugin
Krav:Konfigurera Dev Proxy

Med Dev Proxy kan du generera en OpenAPI-specifikation från snappade API-begäranden och svar. Med Dev Proxy kan du snabbt skapa en OpenAPI-specifikation för ett befintligt API och dra nytta av verktygen som stöder OpenAPI.

Så här genererar du en OpenAPI-specifikation med dev proxy:

1. Aktivera plugin-programmet i konfigurationsfilen OpenApiSpecGeneratorPlugin :

   Fil: devproxyrc.json

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

2. I konfigurationsfilen i listan över URL:er att titta på lägger du till URL:en för det API som du vill generera en OpenAPI-specifikation för:

   Fil: devproxyrc.json

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

   Tips

   Om du vill skapa bättre OpenAPI-specifikationer bör du överväga att använda en lokal språkmodell med Dev Proxy. Mer information finns i Använda en lokal språkmodell.

3. Starta Dev Proxy:

   devproxy
   

4. Starta inspelningsbegäranden genom att trycka på r

5. Utför de begäranden som du vill inkludera i OpenAPI-specifikationen

6. Stoppa inspelningsbegäranden genom att trycka på s

7. Dev Proxy genererar en OpenAPI-specifikation och sparar den i en fil i den aktuella katalogen. Dev Proxy namnger filen efter värdnamnet för API:et följt av aktuellt datum och tid, till exempel: api.example.com-20231219091700.json.

Se även

• OpenApiSpecGeneratorPlugin – fullständig referens
• Använd lokal språkmodell – Förbättra genererade specifikationer
• Vad är en OpenAPI-specifikation – Begrepp
• Ordlista – Dev Proxy-terminologi