OpenApiSpecGeneratorPlugin

Genereert OpenAPI-specificatie in JSON-indeling op basis van de onderschepte aanvragen en antwoorden.

Definitie van invoegtoepassingexemplaren

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

Configuratievoorbeeld

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

Configuratie-eigenschappen

Eigenschappen	Beschrijving	Standaard
includeOptionsRequests	Bepaalt of aanvragen moeten worden opgenomen OPTIONS in de gegenereerde OpenAPI-specificatie	false
specVersion	Bepaalt welke versie moet worden gebruikt voor de gegenereerde OpenAPI-specificatie. Kan worden ingesteld op v2_0 of v3_0	v3_0
specFormat	Bepaalt welke indeling moet worden gebruikt voor de gegenereerde OpenAPI-specificatie. Kan worden ingesteld op Json of Yaml	Json

Opdrachtregelopties

Geen

Opmerkingen

Als u betere OpenAPI-specificaties wilt maken, kunt u overwegen een lokaal taalmodel te gebruiken met Dev Proxy. Met behulp van een lokaal taalmodel genereert de OpenApiSpecGeneratorPlugin gegenereerde duidelijkere bewerkings-id's en beschrijvingen, waardoor u een beter uitgangspunt hebt voor uw OpenAPI-specificatie. Als u een lokaal taalmodel met het OpenApiSpecGeneratorPluginmodel wilt gebruiken, schakelt u het taalmodel in het configuratiebestand in. Zie Een lokaal taalmodel gebruiken voor meer informatie.