OpenApiSpecGeneratorPlugin

JSON formátumban hozza létre az OpenAPI-specifikációt a lehallgatott kérésekből és válaszokból.

Beépülő modulpéldány definíciója

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

Példa konfigurációra

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

Konfigurációs tulajdonságok

Property	Description	Default
includeOptionsRequests	Meghatározza, hogy a kérések szerepeljenek-e OPTIONS a létrehozott OpenAPI-specifikációban	false
ignoreResponseTypes	Meghatározza, hogy figyelmen kívül hagyja-e a választípusokat a létrehozott OpenAPI-specifikációban.	false
specVersion	Meghatározza, hogy melyik verziót használja a létrehozott OpenAPI-specifikáció. Beállítható v2_0 vagy v3_0	v3_0
specFormat	Meghatározza, hogy a létrehozott OpenAPI-specifikáció milyen formátumot használjon. Beállítható Json vagy Yaml	Json
includeParameters	Meghatározza a létrehozott OpenAPI-specifikációban szerepeltetni kívánt lekérdezési sztringparaméterek listáját az alapértelmezett értékekkel együtt.	[]

Parancssori beállítások

None

Remarks

Ha jobb OpenAPI-specifikációkat szeretne létrehozni, fontolja meg egy helyi nyelvi modell használatát a Dev Proxyval. A helyi nyelvi modell használatával a OpenApiSpecGeneratorPlugin rendszer egyértelműbb műveleti azonosítókat és leírásokat hoz létre, így jobb kiindulópontot biztosít az OpenAPI-specifikációhoz. Ha helyi nyelvi modellt szeretne használni a OpenApiSpecGeneratorPluginkonfigurációs fájlban, engedélyezze a nyelvi modellt. További információ: Helyi nyelvi modell használata.

Következő lépés

OpenAPI-specifikáció létrehozása