C#怎么集成Swagger_C#给接口添加中文注释与JWT验证界面【基础】

落浩酱_4776

落浩酱_4776

2026-04-24

199人浏览

原创

Swagger UI 中文注释不显示需检查XML生成路径与IncludeXmlComments一致性;Authorization按钮缺失主因是AddSecurityDefinition与AddSecurityRequirement未成对配置或scheme大小写错误(必须小写bearer);接口需标记[Authorize]才能触发安全要求。

c#怎么集成swagger_c#给接口添加中文注释与jwt验证界面【基础】

Swagger UI 里不显示中文注释、没 Authorization 按钮,不是配置漏了,就是关键参数写错了——尤其是 scheme 必须小写 bearer,大小写错一个字母,按钮就彻底消失。

XML 注释不显示?检查生成路径和 IncludeXmlComments 调用

XML 注释文件得真生成出来,且路径要和 IncludeXmlComments 里传的一致。常见错误是:只在 Debug 模式勾了“XML 文档文件”,Release 下没勾;或者路径拼错,比如硬写 "MyApp.xml" 却没确认实际输出名含版本号或后缀。

  • 右键项目 → 属性 → 生成 → 勾选“XML 文档文件”,路径留默认(如 bin\Debug\net6.0\MyApp.xml)
  • IncludeXmlComments 中的 xmlPath 必须用 Path.Combine(AppContext.BaseDirectory, xmlFile) 拼,不能直接写相对路径
  • 确保控制器方法上写了 /// <summary>用户登录</summary> 这类三斜线注释,且 includeControllerXmlComments:true 已启用

AddSecurityDefinition 和 AddSecurityRequirement 必须成对出现

只加 AddSecurityDefinition("Bearer", ...) 不会出按钮;只加 AddSecurityRequirement 但没定义 scheme,会报错或按钮灰掉。二者缺一不可,且名称必须完全一致。

  • scheme 参数值必须是小写 "bearer",不是 "Bearer" 或 "JWT"
  • AddSecurityRequirement 里 Reference.Id 要和 AddSecurityDefinition 的第一个参数(即 "Bearer")严格匹配
  • 每个需要认证的接口,控制器或方法上必须有 [Authorize],否则 Swagger 不会自动注入该接口的安全要求

Swagger UI 点 Authorize 后请求仍无 Authorization 头?检查接口文档级标注

Swagger UI 不会全局给所有请求加 token,它只对明确声明需要认证的接口才加。即使你全局配了 scheme,如果某个 GET /api/user 方法没标 [Authorize],它的文档就不会带安全要求,UI 就不会塞 header。

C#
C#

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

下载
  • 打开 /swagger/v1/swagger.json,搜索 "security" 字段,确认目标接口的路径下有类似 "security": [{ "Bearer": [] }] 的条目
  • 若没有,说明该接口未被识别为受保护资源——检查是否漏了 [Authorize],或是否用了自定义策略但没在 AddSecurityRequirement 中声明
  • BearerFormat 设为 "JWT" 是可选提示,不影响功能,但建议加上,便于前端理解

中文界面显示异常?别动 index.html,改 JS 注入更稳妥

直接替换 index.html 容易和新版 Swagger UI 冲突;用自定义 JS 注入翻译更轻量、升级友好。关键点在于脚本加载时机和变量名。

  • 在 wwwroot/swagger-custom.js 中写翻译逻辑,确保它在 Swagger UI 初始化后执行(如监听 window.onload 或用 setTimeout 延迟)
  • 不要覆盖整个 window.SwaggerTranslator 对象,而是 patch 其 translate 方法,避免破坏原有逻辑
  • 中文化重点字段包括:"Authorization"、"Try it out"、"Execute"、"Response Body",注意大小写和空格

最常被忽略的是:Swagger 配置代码必须在认证中间件注册之后、UseSwaggerUI() 之前完成;而 UseAuthentication() 又必须在 UseRouting() 之后、UseEndpoints() 之前。顺序错一位,[Authorize] 就形同虚设,Swagger 按钮也只会静默失效。

相关文章

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

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

下载

相关标签:

c#

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

相关专题

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

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

2023.08.08

1052

5

什么是c#
什么是c#

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

2023.08.31

3071

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

2635

11

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

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

2026.02.03

332

18

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

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

2026.02.06

409

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

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

2023.10.19

3168

3

热门下载

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

精品课程

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

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

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

共0课时 | 0人学习