OpenApiSpecGeneratorPlugin
Gera especificações OpenAPI no formato JSON a partir das solicitações e respostas intercetadas.
{
"name": "OpenApiSpecGeneratorPlugin",
"enabled": true,
"pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
"configSection": "openApiSpecGeneratorPlugin"
}
{
"openApiSpecGeneratorPlugin": {
"includeOptionsRequests": false,
"specVersion": "v3_0",
"specFormat": "Json"
}
}
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 |
Nenhuma
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.
Comentários do Dev Proxy
O Dev Proxy é um projeto código aberto. Selecione um link para fornecer comentários: