C#怎么实现Swagger认证配置 C#如何在Swagger UI中添加JWT Bearer Token认证输入框【框架】

梦萱同学_7813

梦萱同学_7813

2026-04-16

862人浏览

原创

Swagger UI 不显示 Authorization 按钮的根本原因是未在 AddSwaggerGen 中同时配置 AddSecurityDefinition(scheme 必须小写 bearer)和 AddSecurityRequirement;且认证中间件 UseAuthentication()/UseAuthorization() 必须在 UseSwaggerUI() 之前,控制器需标注 [Authorize] 并确保 Swagger 正确识别该特性。

c#怎么实现swagger认证配置 c#如何在swagger ui中添加jwt bearer token认证输入框【框架】

Swagger UI 里没出现 Authorization 按钮,Authorize 按钮不显示

根本原因通常是 Swagger 文档生成时没注册 JWT Bearer 方案。Swashbuckle 不会自动猜你用的是 JWT,必须显式声明 AddSecurityDefinition 和 AddSecurityRequirement。

实操上,要在 Program.cs(.NET 6+)中配置两处:

  • 在 builder.Services.AddEndpointsApiExplorer() 后,调用 AddSwaggerGen 时传入配置委托
  • 必须同时定义 SecurityScheme(类型为 SecuritySchemeType.Http,scheme 设为 bearer,bearerFormat 建议设为 JWT)
  • 还要在每个 API 描述里注入 SecurityRequirement,否则按钮只显示、不生效

漏掉任一环节,Authorize 按钮都不会出现。常见错误是只加了 scheme 却忘了 AddSecurityRequirement,或者把 scheme 写成 Bearer(首字母大写)——它必须小写 bearer,否则 OpenAPI 规范不认。

.NET 6+ Program.cs 中 JWT 认证配置顺序错乱导致 401 或文档不加载

Swagger 要求认证中间件、授权策略、文档生成三者顺序严格对齐。最常踩的坑是:在 app.UseSwaggerUI() 前没调用 app.UseAuthentication() 和 app.UseAuthorization(),或反过来把 AddJwtBearer 放在 AddSwaggerGen 后面。

正确顺序是:

  • AddAuthentication().AddJwtBearer() → 注册认证方案
  • AddAuthorization() → 注册默认策略(如 options.DefaultPolicy = new AuthorizationPolicyBuilder().RequireAuthenticatedUser().Build();)
  • AddEndpointsApiExplorer() + AddSwaggerGen() → 此时才能引用前面定义的 scheme 名
  • UseAuthentication() 和 UseAuthorization() 必须在 UseSwaggerUI() 之前,且紧挨着 UseRouting()

顺序错一个位置,Swagger 页面可能空白、控制台报 Failed to load API definition,或者点击 Authorize 后调用接口仍返回 401 —— 实际是因为请求根本没进到认证中间件。

点击 Authorize 输入 token 后,所有接口仍带空 Authorization 头

这是前端行为问题,不是后端配置失败。Swagger UI 默认不会自动把 token 注入到每个请求头,除非你在接口文档里明确标注该接口需要认证。

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载

必须在控制器或方法上加 [Authorize] 特性,并确保 Swashbuckle 能识别这个标记。更关键的是:在 AddSwaggerGen 配置中,要启用 DocInclusionPredicate 并正确处理 AuthorizeAttribute,否则即使加了特性,Swagger 也不会给对应接口添加 security 字段。

推荐做法是用以下配置片段(放在 AddSwaggerGen 委托内):

options.AddSecurityRequirement(new OpenApiSecurityRequirement
{
    {
        new OpenApiSecurityScheme
        {
            Reference = new OpenApiReference { Type = ReferenceType.SecurityScheme, Id = "Bearer" }
        },
        new string[] { }
    }
});

注意这里 Id = "Bearer" 必须和前面 AddSecurityDefinition("Bearer", ...) 的第一个参数完全一致(大小写敏感),否则关联断裂,token 就不会被带上。

Swagger UI 发送请求时 token 被截断或含换行,导致 401

用户手动粘贴 token 到弹窗时,容易带入不可见字符(比如从某些 JWT 网站复制时含 \r\n),Swagger UI 不做清洗,直接拼进 Authorization: Bearer xxx 头里,后端 JwtBearerHandler 解析失败。

这不是代码 bug,但影响调试效率。建议:

  • 在开发环境加个简单日志:在 Program.cs 的 AddJwtBearer 配置里,设置 Events.OnAuthenticationFailed 打印原始 token 长度和前 20 字符,快速判断是否截断
  • 提醒测试人员粘贴后手动删掉首尾空格,或改用 Base64 解码工具验证 token 是否合法
  • 不推荐在生产绕过校验,但开发阶段可临时加 TokenValidationParameters.ValidateLifetime = false 排除过期干扰

真正上线时,前端应通过登录接口获取 token 后存入内存变量,再由 Axios/Fetch 自动注入 header —— Swagger UI 只是调试用,不该承担 token 管理职责。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

c#

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
c#是什么意思
c#是什么意思

C#是一种通用的面向对象编程语言,它在.NET框架上运行,可用于开发各种类型的应用程序。本专题为大家提供c#相关的各种文章、以及下载和课程。

2023.08.08

1072

5

什么是c#
什么是c#

C#(读作C Sharp)是一种现代的、通用的、面向对象的编程语言。它由微软公司开发,于2000年首次发布,主要用于开发Windows桌面应用程序、Web应用程序、移动应用程序以及游戏开发等领域。C#是一种类型安全和托管的编程语言,它结合了C++的强大性能和C语言的简单易学特点,并引入了许多新的特性和概念,如委托、属性、泛型和异步编程等,以提高开发效率和代码可维护性。

2023.08.31

3151

3

C#中base关键字的用法
C#中base关键字的用法

在C#中,base关键字用于访问当前类的基类成员,这包括基类的字段、属性、方法、构造函数、索引器以及事件。想了解更多C#的相关内容,可以阅读本专题下面的文章。

2024.03.13

905

8

C#Task用法
C#Task用法

Task在C#中是用于表示异步操作的对象,它位于System.Threading.Tasks命名空间中。想了解更多C#中各种用法的相关内容,可以阅读本专题下面的文章。

2024.03.14

2655

11

C# 并发与异步编程
C# 并发与异步编程

本专题系统讲解 C# 异步编程与并发控制,重点介绍 async 和 await 关键字、Task 类、线程池管理、并发数据结构、死锁与线程安全问题。通过多个实战项目,帮助学习者掌握 如何在 C# 中编写高效的异步代码,提升应用的并发性能与响应速度。

2026.02.03

332

18

C# 多线程与异步编程
C# 多线程与异步编程

本专题深入讲解 C# 中多线程与异步编程的核心概念与实战技巧,包括线程池管理、Task 类的使用、async/await 异步编程模式、并发控制与线程同步、死锁与竞态条件的解决方案。通过实际项目,帮助开发者掌握 如何在 C# 中构建高并发、低延迟的异步系统,提升应用性能和响应速度。

2026.02.06

429

20

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

2026.03.11

631

24

C# Unity游戏开发与ECS架构实践
C# Unity游戏开发与ECS架构实践

本专题聚焦 C# 在 Unity 游戏开发中的应用,系统讲解 ECS(Entity-Component-System)架构设计、游戏对象管理、性能优化与内存控制策略。通过实际游戏案例,帮助开发者构建高性能、结构清晰的游戏系统,提高游戏开发效率与运行性能。

2026.04.13

329

20

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习