Generieren einer OpenAPI-Spezifikation

Dev Proxy ermöglicht es Ihnen, eine OpenAPI-Spezifikation aus den abgefangenen API-Anforderungen und -Antworten zu generieren. Mit Dev Proxy können Sie schnell eine OpenAPI-Spezifikation für eine vorhandene API erstellen und von den Tools profitieren, die OpenAPI unterstützen.

So generieren Sie eine OpenAPI-Spezifikation mit Dev Proxy:

1. Aktivieren Sie in der Konfigurationsdatei das OpenApiSpecGeneratorPlugin Plug-In:

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

2. Fügen Sie in der Konfigurationsdatei zur Liste der zu überwachenden URLs die URL der API hinzu, für die Sie eine OpenAPI-Spezifikation generieren möchten:

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

   Tipp

   Um bessere OpenAPI-Spezifikationen zu erstellen, sollten Sie ein lokales Sprachmodell mit Dev Proxy verwenden. Weitere Informationen finden Sie unter Verwenden eines lokalen Sprachmodells.

3. Dev-Proxy starten:

   devproxy
   

4. Starten von Aufzeichnungsanforderungen durch Drücken des Drückens r

5. Führen Sie die Anforderungen aus, die Sie in die OpenAPI-Spezifikation aufnehmen möchten.

6. Beenden von Aufzeichnungsanforderungen durch Drücken des Drückens s

7. Dev Proxy generiert eine OpenAPI-Spezifikation und speichert sie in einer Datei im aktuellen Verzeichnis. Dev Proxy benennt die Datei nach dem Hostnamen der API, gefolgt vom aktuellen Datum und der aktuellen Uhrzeit, z. B.: api.example.com-20231219091700.json.