OpenAPI-specifikáció létrehozása

A Dev Proxy lehetővé teszi, hogy openAPI-specifikációt hozzon létre az elfogt API-kérésekből és válaszokból. A Dev Proxy használatával gyorsan létrehozhat egy OpenAPI-specifikációt egy meglévő API-hoz, és kihasználhatja az OpenAPI-t támogató eszközkészletet.

OpenAPI-specifikáció létrehozása Dev Proxy használatával:

1. A konfigurációs fájlban engedélyezze a beépülő modult OpenApiSpecGeneratorPlugin :

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

2. A konfigurációs fájlban adja hozzá a megtekinteni kívánt URL-címek listájához annak az API-nak az URL-címét, amelyhez OpenAPI-specifikációt szeretne létrehozni:

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

   Tipp.

   Ha jobb OpenAPI-specifikációkat szeretne létrehozni, fontolja meg egy helyi nyelvi modell használatát a Dev Proxyval. További információ: Helyi nyelvi modell használata.

3. Fejlesztői proxy indítása:

   devproxy
   

4. Nyomja meg a r, hogy elkezdje a kérések felvételét

5. Hajtsa végre az OpenAPI-specifikációba felvenni kívánt kéréseket

6. A kérések rögzítésének leállításához nyomja meg a s gombot.

7. A Dev Proxy létrehoz egy OpenAPI-specifikációt, és menti azt az aktuális könyvtárban lévő fájlba. A dev proxy az API állomásneve után adja a fájlt, majd az aktuális dátumot és időpontot, például: api.example.com-20231219091700.json.