Создание спецификации OpenAPI

На первый взгляд
Цель: Создание спецификации OpenAPI из перехватанных запросов API
Время: 10 минут
Подключаемые модули:OpenApiSpecGeneratorPlugin
Предварительные требования:настройка прокси-сервера разработки

Прокси-сервер разработки позволяет создавать спецификацию OpenAPI из перехватанных запросов и ответов API. С помощью прокси-сервера разработки можно быстро создать спецификацию OpenAPI для существующего API и воспользоваться инструментами, поддерживающими OpenAPI.

Чтобы создать спецификацию OpenAPI с помощью прокси-сервера разработки:

1. В файле конфигурации включите плагин OpenApiSpecGeneratorPlugin:

   Файл: devproxyrc.json

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

2. В файле конфигурации добавьте в список наблюдаемых URL-адресов URL-адрес API, для которого вы хотите сгенерировать спецификацию OpenAPI.

   Файл: devproxyrc.json

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

   Совет

   Чтобы создать более улучшенные спецификации OpenAPI, рассмотрите возможность использования локальной языковой модели с прокси-сервером разработки. Дополнительные сведения см. в разделе "Использование локальной языковой модели".

3. Запуск прокси-сервера разработки:

   devproxy
   

4. Запуск запросов записи путем нажатия клавиши r

5. Выполнение запросов, которые необходимо включить в спецификацию OpenAPI

6. Остановить запросы на запись, нажав клавишу s

7. Прокси-сервер разработки создает спецификацию OpenAPI и сохраняет ее в файл в текущем каталоге. Прокси-сервер разработки присваивает файлу имя узла API, за которым следует текущая дата и время, например: api.example.com-20231219091700.json

См. также

• OpenApiSpecGeneratorPlugin — полная ссылка
• Использование локальной языковой модели . Улучшение созданных спецификаций
• Что такое спецификация OpenAPI — основные понятия
• Глоссарий — терминология прокси для разработки