Ler em inglês

Partilhar via


OpenApiSpecGeneratorPlugin

Gera especificações OpenAPI no formato JSON a partir das solicitações e respostas intercetadas.

Captura de ecrã de duas janelas da linha de comandos. Um mostra solicitações de API de gravação do Dev Proxy. O outro mostra a especificação OpenAPI gerada.

Definição de instância de plug-in

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

Exemplo de configuração

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

Propriedades de configuração

Property Description Predefinido
includeOptionsRequests Determina se as solicitações devem ser incluídas OPTIONS na especificação OpenAPI gerada false
specVersion Determina qual versão usar para a especificação OpenAPI gerada. Pode ser definido como v2_0 ou v3_0 v3_0
specFormat Determina qual formato usar para a especificação OpenAPI gerada. Pode ser definido como Json ou Yaml Json

Opções de linha de comando

Nenhuma

Observações

Para criar melhores especificações OpenAPI, considere usar um modelo de idioma local com o Dev Proxy. Usando um modelo de idioma local, o OpenApiSpecGeneratorPlugin gera IDs de operação e descrições mais claras, dando-lhe um melhor ponto de partida para sua especificação OpenAPI. Para usar um modelo de idioma local com o OpenApiSpecGeneratorPlugin, habilite o modelo de idioma no arquivo de configuração. Para obter mais informações, consulte Usar um modelo de idioma local.