OpenApiSpecGeneratorPlugin

Menghasilkan spesifikasi OpenAPI dalam format JSON dari permintaan dan respons yang disadap.

Contoh konfigurasi

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

Properti konfigurasi

Property	Description	Default
includeOptionsRequests	Menentukan apakah akan menyertakan OPTIONS permintaan dalam spesifikasi OpenAPI yang dihasilkan	false
ignoreResponseTypes	Menentukan apakah akan mengabaikan jenis respons dalam spesifikasi OpenAPI yang dihasilkan.	false
specVersion	Menentukan versi mana yang akan digunakan untuk spesifikasi OpenAPI yang dihasilkan. Dapat diatur ke v2_0 atau v3_0	v3_0
specFormat	Menentukan format mana yang akan digunakan untuk spesifikasi OpenAPI yang dihasilkan. Dapat diatur ke Json atau Yaml	Json
includeParameters	Menentukan daftar parameter string kueri untuk disertakan dalam spesifikasi OpenAPI yang dihasilkan, bersama dengan nilai defaultnya.	[]

Opsi baris Perintah

None

Remarks

Untuk membuat spesifikasi OpenAPI yang lebih baik, pertimbangkan untuk menggunakan model bahasa lokal dengan Dev Proxy. Menggunakan model bahasa lokal, OpenApiSpecGeneratorPlugin menghasilkan ID dan deskripsi operasi yang lebih jelas, memberi Anda titik awal yang lebih baik untuk spesifikasi OpenAPI Anda. Untuk menggunakan model bahasa lokal dengan OpenApiSpecGeneratorPlugin, aktifkan model bahasa dalam file konfigurasi. Untuk informasi selengkapnya, lihat Menggunakan model bahasa lokal.

Langkah selanjutnya

Hasilkan spesifikasi OpenAPI