.Net6+webApi 给swagger添加token

最新推荐文章于 2025-04-08 14:45:48 发布

菜鸟爱飞不飞

最新推荐文章于 2025-04-08 14:45:48 发布

阅读量6.4k

点赞数 4

分类专栏： C# .net core 文章标签： swagger

本文链接：https://blog.youkuaiyun.com/weixin_39305029/article/details/123428537

版权

.net core 同时被 2 个专栏收录

36 篇文章

订阅专栏

25 篇文章

订阅专栏

开发webApi 的时候，大多数情况会使用swagger调试接口，但是当api添加了权限认证注解的时候，就必须携带token才能访问，否则会返回401状态码提示无访问权限。
解决办法有两种：
（1）使用postman等调试工具携带token调试；
（2）给swagger接口文档的请求头添加token。
本文主要演示给swagger接口文档的请求头添加token。

一、修改Program.cs

将builder.Services.AddSwaggerGen()添加以下配置

builder.Services.AddSwaggerGen(s =>
{
    //添加安全定义
    s.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme
    {
        Description = "请输入token,格式为 Bearer xxxxxxxx（注意中间必须有空格）",
        Name = "Authorization",
        In = ParameterLocation.Header,
        Type = SecuritySchemeType.ApiKey,
        BearerFormat = "JWT",
        Scheme = "Bearer"
    });
    //添加安全要求
    s.AddSecurityRequirement(new OpenApiSecurityRequirement {
        {
            new OpenApiSecurityScheme{
                Reference =new OpenApiReference{
                    Type = ReferenceType.SecurityScheme,
                    Id ="Bearer"
                }
            },new string[]{ }
        }
    });
});