Delen via

OpenApiSpecGeneratorPlugin

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

Schermopname van twee opdrachtpromptvensters. Een van de api-aanvragen voor het opnemen van dev-proxy's. De andere toont de gegenereerde OpenAPI-specificatie.

Definitie van invoegtoepassingexemplaren

{
  "name": "OpenApiSpecGeneratorPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
  "configSection": "openApiSpecGeneratorPlugin"
}

Configuratievoorbeeld

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

Configuratie-eigenschappen

Property Description Default
includeOptionsRequests Bepaalt of aanvragen moeten worden opgenomen OPTIONS in de gegenereerde OpenAPI-specificatie false
ignoreResponseTypes Bepaalt of antwoordtypen in de gegenereerde OpenAPI-specificatie moeten worden genegeerd. 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
includeParameters Bepaalt de lijst met queryreeksparameters die moeten worden opgenomen in de gegenereerde OpenAPI-specificatie, samen met de standaardwaarden. []

Opdrachtregelopties

None

Remarks

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.

Volgende stap

Een OpenAPI-specificatie genereren