OpenApiSpecGeneratorPlugin

Generuje specifikace OpenAPI ve formátu JSON z zachycených požadavků a odpovědí.

Definice instance modulu plug-in

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

Příklad konfigurace

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

Vlastnosti konfigurace

Property	Description	Default
includeOptionsRequests	Určuje, zda se mají zahrnout OPTIONS požadavky do vygenerované specifikace OpenAPI.	false
ignoreResponseTypes	Určuje, zda se mají ignorovat typy odpovědí ve vygenerované specifikaci OpenAPI.	false
specVersion	Určuje, která verze se má použít pro vygenerovanou specifikaci OpenAPI. Lze nastavit na v2_0 nebo v3_0	v3_0
specFormat	Určuje, který formát se má použít pro vygenerovanou specifikaci OpenAPI. Lze nastavit na Json nebo Yaml	Json
includeParameters	Určuje seznam parametrů řetězce dotazu, které mají být zahrnuty do vygenerované specifikace OpenAPI spolu s jejich výchozími hodnotami.	[]

Možnosti příkazového řádku

None

Remarks

Pokud chcete vytvořit lepší specifikace OpenAPI, zvažte použití místního jazykového modelu s dev proxy serverem. Pomocí místního jazykového modelu vygeneruje OpenApiSpecGeneratorPlugin jasnější ID a popisy operací, což vám poskytne lepší výchozí bod pro specifikaci OpenAPI. Pokud chcete použít místní jazykový model s jazykem OpenApiSpecGeneratorPlugin, povolte jazykový model v konfiguračním souboru. Další informace naleznete v tématu Použití místního jazykového modelu.

Další krok

Vygenerování specifikace OpenAPI