.net core Swagger添加bearer token参数

最新推荐文章于 2024-12-24 21:19:39 发布

traye2020

最新推荐文章于 2024-12-24 21:19:39 发布

阅读量2.8k

点赞数

分类专栏： NetCore 文章标签： c#

原文链接：https://www.cnblogs.com/mosakashaka/p/13151629.html

版权

NetCore 专栏收录该内容

5 篇文章

订阅专栏

本文介绍了如何在ASP.NET应用中通过Swagger集成Bearer JWT令牌验证，并详细说明了如何设置OpenAPI安全定义和要求，以便在Swagger UI中实现API方法的授权功能。

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

引入swagger后，在services.AddSwaggerGen中增加如下内容
//Register the Swagger generator, defining 1 or more Swagger documents
services.AddSwaggerGen(c =>
{
…

            //Bearer 的scheme定义
            var securityScheme = new OpenApiSecurityScheme()
            {
                Description = "JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\"",
                Name = "Authorization",
                //参数添加在头部
                In = ParameterLocation.Header,
                //使用Authorize头部
                Type = SecuritySchemeType.Http,
                //内容为以 bearer开头
                Scheme = "bearer",
                BearerFormat = "JWT"
            };

            //把所有方法配置为增加bearer头部信息
            var securityRequirement = new OpenApiSecurityRequirement
                {
                    {
                            new OpenApiSecurityScheme
                            {
                                Reference = new OpenApiReference
                                {
                                    Type = ReferenceType.SecurityScheme,
                                    Id = "bearerAuth"
                                }
                            },
                            new string[] {}
                    }
                };

            //注册到swagger中
            c.AddSecurityDefinition("bearerAuth", securityScheme);
            c.AddSecurityRequirement(securityRequirement);
        });
        添加成功后，swagger右上方会有一个Authroize按钮，点击后可以输入bearer token。

在这里插入图片描述
每个API方法后，会有一个锁的标志，表明该方法会传递bearer token。
转载于 https://www.cnblogs.com/mosakashaka/p/13151629.html