Generowanie specyfikacji interfejsu OpenAPI

Serwer proxy deweloperów umożliwia generowanie specyfikacji interfejsu OpenAPI na podstawie przechwyconych żądań interfejsu API i odpowiedzi. Za pomocą serwera proxy deweloperskiego można szybko utworzyć specyfikację interfejsu OpenAPI dla istniejącego interfejsu API i skorzystać z narzędzi obsługujących interfejs OpenAPI.

Aby wygenerować specyfikację interfejsu OpenAPI przy użyciu serwera proxy deweloperskiego:

1. W pliku konfiguracji włącz wtyczkę OpenApiSpecGeneratorPlugin :

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

2. W pliku konfiguracji do listy adresów URL do obejrzenia dodaj adres URL interfejsu API, dla którego chcesz wygenerować specyfikację interfejsu OpenAPI:

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

   Napiwek

   Aby utworzyć lepsze specyfikacje interfejsu OpenAPI, rozważ użycie lokalnego modelu językowego z serwerem proxy deweloperów. Aby uzyskać więcej informacji, zobacz Używanie lokalnego modelu językowego.

3. Uruchom serwer proxy deweloperów:

   devproxy
   

4. Rozpocznij nagrywanie żądań, naciskając r

5. Wykonywanie żądań, które mają zostać uwzględnione w specyfikacji interfejsu OpenAPI

6. Zatrzymywanie żądań nagrywania przez naciśnięcie s

7. Serwer proxy dev generuje specyfikację interfejsu OpenAPI i zapisuje go w pliku w bieżącym katalogu. Serwer proxy deweloperów nazywa plik po nazwie hosta interfejsu API, po którym następuje bieżąca data i godzina, na przykład: api.example.com-20231219091700.json.