OpenApiSpecGeneratorPlugin

Generiert openAPI-Spezifikation im JSON-Format aus den abgefangenen Anforderungen und Antworten.

Definition der Plug-In-Instanz

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

Konfigurationsbeispiel

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

Konfigurationseigenschaften

Eigenschaft	BESCHREIBUNG	Standard
includeOptionsRequests	Bestimmt, ob Anforderungen in die generierte OpenAPI-Spezifikation eingeschlossen OPTIONS werden sollen.	false
specVersion	Bestimmt, welche Version für die generierte OpenAPI-Spezifikation verwendet werden soll. Kann auf v2_0 oder v3_0 festgelegt werden	v3_0

Befehlszeilenoptionen

Keine

Hinweise

Um bessere OpenAPI-Spezifikationen zu erstellen, sollten Sie ein lokales Sprachmodell mit Dev Proxy verwenden. Mithilfe eines lokalen Sprachmodells generiert die OpenApiSpecGeneratorPlugin Löschvorgangs-IDs und -Beschreibungen einen besseren Ausgangspunkt für Ihre OpenAPI-Spezifikation. Um ein lokales Sprachmodell mit dem OpenApiSpecGeneratorPluginSprachmodell zu verwenden, aktivieren Sie das Sprachmodell in der Konfigurationsdatei. Weitere Informationen finden Sie unter Verwenden eines lokalen Sprachmodells.