0%

Swagger生成的接口需要权限验证的处理方法 - SuperShen - 博客园

Excerpt

通常开发API的时候需要对接口进行权限验证,而我们在使用Swagger生成接口文档界面的时候,直接调用需要权限验证的接口会提示”当前用户没有登陆” 为了解决此问题,我们需要更改一下Swagger的配置, 找到Startup文件,我们看到Swagger的配置如下: 现在我们添加一下


通常开发API的时候需要对接口进行权限验证,而我们在使用Swagger生成接口文档界面的时候,直接调用需要权限验证的接口会提示”当前用户没有登陆”

为了解决此问题,我们需要更改一下Swagger的配置,

找到Startup文件,我们看到Swagger的配置如下:

1

2

3

4

5

6

services.AddSwaggerGen(options =>

            {

                options.SwaggerDoc("v1", new Info { Title = "YjJob API", Version = "v1" });

                options.DocInclusionPredicate((docName, description) => true);

            });

现在我们添加一下配置配置:

1

2

3

4

5

6

7

8

9

10

11

12

services.AddSwaggerGen(options =>

            {

                options.SwaggerDoc("v1", new Info { Title = "YjJob API", Version = "v1" });

                options.DocInclusionPredicate((docName, description) => true);

                options.AddSecurityDefinition("Bearer", new ApiKeyScheme

                {

                    Description = "Authorization format : Bearer {token}",

                    Name = "Authorization",

                    In = "header",

                    Type = "apiKey"

                });

            });

  修改后我们可以看到生成的Swagger UI界面新增了一个“Authorize”按钮:

点击“Authorize”按钮弹出以下界面

在value文本框中输入”Bearer “+token(登陆接口返回的access_token),然后点击“Authorize”按钮。之后再调用需要权限验证的接口就可以正常调用了