OpenApiSpecGeneratorPlugin

Genererar OpenAPI-specifikation i JSON-format från snappade begäranden och svar.

Konfigurationsexempel

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

Konfigurationsegenskaper

Property	Description	Default
includeOptionsRequests	Avgör om begäranden ska inkluderas OPTIONS i den genererade OpenAPI-specifikationen	false
ignoreResponseTypes	Avgör om svarstyper ska ignoreras i den genererade OpenAPI-specifikationen.	false
specVersion	Avgör vilken version som ska användas för den genererade OpenAPI-specifikationen. Kan anges till v2_0 eller v3_0	v3_0
specFormat	Avgör vilket format som ska användas för den genererade OpenAPI-specifikationen. Kan anges till Json eller Yaml	Json
includeParameters	Avgör listan över frågesträngsparametrar som ska inkluderas i den genererade OpenAPI-specifikationen, tillsammans med deras standardvärden.	[]

Kommandoradsalternativ

None

Remarks

Om du vill skapa bättre OpenAPI-specifikationer bör du överväga att använda en lokal språkmodell med Dev Proxy. Med hjälp av en lokal språkmodell OpenApiSpecGeneratorPlugin genererar tydligare åtgärds-ID:er och beskrivningar, vilket ger dig en bättre startpunkt för OpenAPI-specifikationen. Om du vill använda en lokal språkmodell med OpenApiSpecGeneratorPluginaktiverar du språkmodellen i konfigurationsfilen. Mer information finns i Använda en lokal språkmodell.

Nästa steg

Generera en OpenAPI-specifikation