OpenApiSpecGeneratorPlugin

Kesilen isteklerden ve yanıtlardan JSON biçiminde OpenAPI belirtimi oluşturur.

Eklenti örneği tanımı

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

Yapılandırma örneği

{
  "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"
    ]
  }
}

Yapılandırma özellikleri

Property	Description	Default
includeOptionsRequests	Oluşturulan OpenAPI belirtimine isteklerin dahil OPTIONS edilip edilmeyeceğini belirler	false
ignoreResponseTypes	Oluşturulan OpenAPI belirtimindeki yanıt türlerinin yoksayılıp yoksayılmayacağını belirler.	false
specVersion	Oluşturulan OpenAPI belirtimi için hangi sürümün kullanılacağını belirler. v2_0 veya v3_0 olarak ayarlanabilir	v3_0
specFormat	Oluşturulan OpenAPI belirtimi için kullanılacak biçimi belirler. Json veya Yaml olarak ayarlanabilir	Json
includeParameters	Oluşturulan OpenAPI belirtimine eklenecek sorgu dizesi parametrelerinin listesini ve bunların varsayılan değerlerini belirler.	[]

Komut satırı seçenekleri

None

Remarks

Daha iyi OpenAPI belirtimleri oluşturmak için Dev Proxy ile yerel dil modeli kullanmayı göz önünde bulundurun. Yerel dil modeli kullanarak daha OpenApiSpecGeneratorPlugin net işlem kimlikleri ve açıklamalar oluşturur ve OpenAPI belirtiminiz için daha iyi bir başlangıç noktası sağlar. ile OpenApiSpecGeneratorPluginyerel dil modeli kullanmak için, yapılandırma dosyasında dil modelini etkinleştirin. Daha fazla bilgi için bkz . Yerel dil modeli kullanma.

Sonraki adım

OpenAPI belirtimi oluşturma