Plug-in OpenApiSpecGeneratorPlugin

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

Definição de instância do 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"
  }
}

Propriedades de configuração

Propriedade	Descrição	Padrão
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 de OpenAPI gerada. Pode ser definido como v2_0 ou v3_0	v3_0

Opções de linha de comando

Nenhum

Comentários

Para criar melhores especificações de OpenAPI, considere usar um modelo de idioma local com o Dev Proxy. Usando um modelo de idioma local, o gera OpenApiSpecGeneratorPlugin IDs e descrições de operação mais claras, fornecendo um ponto de partida melhor 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.