Интерфейс Swashbuckle не отображает описание схемы безопасности OAuth2 - PullRequest
0 голосов
/ 27 февраля 2020

Я пытаюсь добавить схему безопасности на свою пользовательскую страницу пользовательского интерфейса, и она успешно добавляется, однако мое описание не отображается или вообще не отображается на пользовательской странице. Я хочу, чтобы он отображался успешно, так как я переключу этот код на IOperationFilter, и его описание будет варьироваться в зависимости от конечной точки. На данный момент, однако, это мой код для AddSwaggerGen:

services.AddSwaggerGen(options =>
        {
            options.SwaggerDoc("v1", new OpenApiInfo
            {
                Title = "MyAPI",
                Version = "v1"
            });

            options.EnableAnnotations(true);
            options.AddSecurityDefinition("oauth2", new OpenApiSecurityScheme
            {
                Description = "This is my description that's not showing", // I want this to display on the UI
                Type = SecuritySchemeType.OAuth2,
                Flows = new OpenApiOAuthFlows
                {
                    ClientCredentials = new OpenApiOAuthFlow
                    {
                        TokenUrl = new Uri("/token", UriKind.Relative)
                    }
                }
            });

            options.AddSecurityRequirement(new OpenApiSecurityRequirement
            {
                {
                    new OpenApiSecurityScheme
                    {
                        Reference = new OpenApiReference
                        {
                            Type = ReferenceType.SecurityScheme,
                            Id = "Bearer"
                        },
                        Scheme = "oauth2",
                        Name = "Bearer",
                        In = ParameterLocation.Header
                    },
                    new List<string>()
                }
            });
        });

Это мои доступные авторизации, которые генерируются в пользовательском интерфейсе: enter image description here

Я бы предположил мое описание должно go, где оно описывает области, как это делает для JWT. Я пропускаю конфигурацию? Я использую Swashbuckle.AspNetCore 5.0.0

1 Ответ

1 голос
/ 27 февраля 2020

Это известная проблема с пользовательским интерфейсом Swagger:

https://github.com/swagger-api/swagger-ui/issues/5230

...