OpenApiSpecGeneratorPlugin

  • Статья

Создает спецификацию OpenAPI в формате JSON из перехватанных запросов и ответов.

Снимок экрана: две окна командной строки. В одной из них показаны запросы API записи прокси-сервера разработки. В другом показана созданная спецификация OpenAPI.

Определение экземпляра подключаемого модуля

{
  "name": "OpenApiSpecGeneratorPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
  "configSection": "openApiSpecGeneratorPlugin"
}

Пример конфигурации

{
  "openApiSpecGeneratorPlugin": {
    "includeOptionsRequests": false
  }
}

Свойства конфигурации

Свойство Description По умолч.
includeOptionsRequests Определяет, следует ли включать OPTIONS запросы в созданную спецификацию OpenAPI. false

Параметры командной строки

нет

Замечания

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