OpenApiSpecGeneratorPlugin

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

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

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/rc.schema.json",
  "plugins": [
    {
      "name": "OpenApiSpecGeneratorPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
      "configSection": "openApiSpecGeneratorPlugin"
    }
  ],
  "openApiSpecGeneratorPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/openapispecgeneratorplugin.schema.json",
    "includeOptionsRequests": false,
    "ignoreResponseTypes": false,
    "specVersion": "v3_0",
    "specFormat": "Json",
    "includeParameters": [
      "api-version"
    ]
  }
}

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

Property	Description	Default
includeOptionsRequests	Определяет, следует ли включать OPTIONS запросы в созданную спецификацию OpenAPI.	false
ignoreResponseTypes	Определяет, следует ли игнорировать типы ответов в созданной спецификации OpenAPI.	false
specVersion	Определяет версию, используемую для созданной спецификации OpenAPI. Можно задать v2_0 или v3_0	v3_0
specFormat	Определяет формат, используемый для созданной спецификации OpenAPI. Можно задать Json или Yaml	Json
includeParameters	Определяет список параметров строки запроса для включения в созданную спецификацию OpenAPI вместе со значениями по умолчанию.	[]

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

None

Remarks

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

Следующий шаг

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