Swagger生成的接口需要权限验证的处理方法

最新推荐文章于 2025-06-16 16:13:01 发布

weixin_33778544

最新推荐文章于 2025-06-16 16:13:01 发布

阅读量5.1k

点赞数 1

CC 4.0 BY-SA版权

文章标签： java ui c#

原文链接：http://www.cnblogs.com/adawoo/p/8349598.html

本文介绍如何在Swagger中配置权限验证，以解决直接调用需要权限验证接口时出现的当前用户没有登录的问题。通过添加安全定义配置，使得可以在Swagger UI界面中手动输入token进行授权。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

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

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

找到Startup文件，我们看到Swagger的配置如下：

services.AddSwaggerGen(options =>
            {
                options.SwaggerDoc("v1", new Info { Title = "YjJob API", Version = "v1" });
                options.DocInclusionPredicate((docName, description) => true);

            });

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

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"
                });//api界面新增authorize按钮
            });

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