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/DevProxy.Plugins.dll",
  "configSection": "openApiSpecGeneratorPlugin"
}

Konfigurationsbeispiel

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

Konfigurationseigenschaften

Property	Description	Default
includeOptionsRequests	Bestimmt, ob Anforderungen in die generierte OpenAPI-Spezifikation eingeschlossen OPTIONS werden sollen.	false
ignoreResponseTypes	Bestimmt, ob Antworttypen in der generierten OpenAPI-Spezifikation ignoriert 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
specFormat	Bestimmt, welches Format für die generierte OpenAPI-Spezifikation verwendet werden soll. Kann auf Json oder Yaml festgelegt werden	Json
includeParameters	Bestimmt die Liste der Abfragezeichenfolgenparameter, die in die generierte OpenAPI-Spezifikation eingeschlossen werden sollen, zusammen mit ihren Standardwerten.	[]

Befehlszeilenoptionen

None

Remarks

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.

Nächster Schritt

Generieren einer OpenAPI-Spezifikation