OpenApiSpecGeneratorPlugin

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

Definition av plugin-instans

{
  "name": "OpenApiSpecGeneratorPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
  "configSection": "openApiSpecGeneratorPlugin"
}

Konfigurationsexempel

{
  "openApiSpecGeneratorPlugin": {
    "includeOptionsRequests": false,
    "specVersion": "v3_0",
    "specFormat": "Json"
  }
}

Konfigurationsegenskaper

Property	beskrivning	Standard
includeOptionsRequests	Avgör om begäranden ska inkluderas OPTIONS 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

Kommandoradsalternativ

Ingen

Kommentarer

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.