OpenApiSpecGeneratorPlugin

Genera specifiche OpenAPI in formato JSON dalle richieste e dalle risposte intercettate.

Definizione dell'istanza del plug-in

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

Esempio di configurazione

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

Proprietà di configurazione

Proprietà	Descrizione	Default
includeOptionsRequests	Determina se includere OPTIONS le richieste nella specifica OpenAPI generata	false
specVersion	Determina la versione da usare per la specifica OpenAPI generata. Può essere impostato su v2_0 o v3_0	v3_0
specFormat	Determina il formato da utilizzare per la specifica OpenAPI generata. Può essere impostato su Json o Yaml	Json

Opzioni della riga di comando

None

Osservazioni:

Per creare specifiche OpenAPI migliori, è consigliabile usare un modello linguistico locale con Dev Proxy. Usando un modello linguistico locale, genera OpenApiSpecGeneratorPlugin ID e descrizioni delle operazioni più chiari, offrendo un punto di partenza migliore per la specifica OpenAPI. Per usare un modello linguistico locale con OpenApiSpecGeneratorPlugin, abilitare il modello linguistico nel file di configurazione. Per altre informazioni, vedere Usare un modello linguistico locale.