OpenApiSpecGeneratorPlugin

가로채는 요청 및 응답에서 JSON 형식으로 OpenAPI 사양을 생성합니다.

플러그 인 인스턴스 정의

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

구성 예제

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

구성 속성

Property	Description	Default
includeOptionsRequests	생성된 OpenAPI 사양에 요청을 포함 OPTIONS 할지 여부를 결정합니다.	false
ignoreResponseTypes	생성된 OpenAPI 사양에서 응답 유형을 무시할지 여부를 결정합니다.	false
specVersion	생성된 OpenAPI 사양에 사용할 버전을 결정합니다. v2_0 또는 v3_0 설정할 수 있습니다.	v3_0
specFormat	생성된 OpenAPI 사양에 사용할 형식을 결정합니다. Json 또는 Yaml 설정할 수 있습니다.	Json
includeParameters	생성된 OpenAPI 사양에 포함할 쿼리 문자열 매개 변수 목록을 기본값과 함께 결정합니다.	[]

명령줄 옵션

None

Remarks

더 나은 OpenAPI 사양을 만들려면 개발자 프록시와 함께 로컬 언어 모델을 사용하는 것이 좋습니다. 로컬 언어 모델을 OpenApiSpecGeneratorPlugin 사용하여 보다 명확한 작업 ID 및 설명을 생성하여 OpenAPI 사양에 대한 더 나은 시작점을 제공합니다. 로컬 언어 모델을 OpenApiSpecGeneratorPlugin사용하려면 구성 파일에서 언어 모델을 사용하도록 설정합니다. 자세한 내용은 로컬 언어 모델 사용을 참조하세요.

다음 단계

OpenAPI 사양 생성