Generowanie specyfikacji interfejsu OpenAPI

Na pierwszy rzut oka
Celem: Tworzenie specyfikacji interfejsu OpenAPI na podstawie przechwyconych żądań interfejsu API
Czas: 10 minut
Plugins:OpenApiSpecGeneratorPlugin
Wymagania wstępne:konfigurowanie serwera proxy deweloperskiego

Proxy dla deweloperów umożliwia generowanie specyfikacji OpenAPI na podstawie przechwyconych żądań i odpowiedzi API. 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 :

   Plik: devproxyrc.json

   {
     "plugins": [
       {
         "name": "OpenApiSpecGeneratorPlugin",
         "enabled": true,
         "pluginPath": "~appFolder/plugins/DevProxy.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:

   Plik: devproxyrc.json

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

   Napiwek

   Aby utworzyć lepsze specyfikacje OpenAPI, rozważ użycie lokalnego modelu językowego z Dev Proxy. 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. Dev Proxy generuje specyfikację OpenAPI i zapisuje ją w pliku w bieżącym katalogu. Dev Proxy nazywa plik używając nazwy hosta API, a następnie bieżącej daty i godziny, na przykład: api.example.com-20231219091700.json.

Zrzut ekranu przedstawiający dwa okna wiersza polecenia. Jedno z nich pokazuje rejestrowanie żądań API przez serwer proxy dla programistów. Drugie pokazuje wygenerowaną specyfikację OpenAPI.

Zobacz także

• OpenApiSpecGeneratorPlugin — pełna dokumentacja
• Korzystanie z lokalnego modelu językowego — ulepszanie wygenerowanych specyfikacji
• Co to jest specyfikacja interfejsu OpenAPI — Pojęcia
• Słownik: terminologia Proxy deweloperskie