OpenApiSpecGeneratorPlugin

2025-07-14

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

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

{
  "name": "OpenApiSpecGeneratorPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
  "configSection": "openApiSpecGeneratorPlugin"
}

Configuration example

{
  "openApiSpecGeneratorPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/openapispecgeneratorplugin.schema.json",
    "includeOptionsRequests": false,
    "specVersion": "v3_0",
    "specFormat": "Json",
    "includeParameters": [
      "api-version"
    ]
  }
}

Configuration properties

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

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

None

Remarks

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

Next step

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