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/DevProxy.Plugins.dll",
  "configSection": "openApiSpecGeneratorPlugin"
}

Exemplo de configuração

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

Propriedades de configuração

Property	Description	Default
includeOptionsRequests	Determina se as solicitações devem ser incluídas OPTIONS na especificação OpenAPI gerada	false
ignoreResponseTypes	Determina se os tipos de resposta devem ser ignorados na especificação de 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
specFormat	Determina qual formato usar para a especificação OpenAPI gerada. Pode ser definido como Json ou Yaml	Json
includeParameters	Determina a lista de parâmetros de cadeia de caracteres de consulta a serem incluídos na especificação OpenAPI gerada, juntamente com seus valores padrão.	[]

Opções de linha de comando

None

Remarks

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.

Próxima etapa

Gerar uma especificação OpenAPI