c#如何使用Swagger文档_c#Swagger文档看这一篇就够了_保姆级教程

尼克

尼克

2026-04-24

1038人浏览

原创

swagger在c#中需通过swashbuckle.aspnetcore实现三步闭环:生成json(swaggergen)、托管json(useswagger)、渲染ui(useswaggerui);缺一不可,且依赖.net版本与包版本严格匹配,中间件注册顺序及xml文档配置也必须正确。

c#如何使用swagger文档_c#swagger文档看这一篇就够了_保姆级教程

Swagger 文档在 C# 里不是开箱即用的功能,它依赖 Swashbuckle.AspNetCore 包完成三件事:生成 JSON 描述(SwaggerGen)、托管该 JSON(UseSwagger)、渲染成网页(UseSwaggerUI)。漏掉任意一环,页面打不开、接口不显示、参数变 object——都不是配置“没生效”,而是根本没连通。

安装 Swashbuckle.AspNetCore 时版本对不上就直接失败

包装不进去?十有八九是 .NET 版本和包版本不匹配。NuGet 搜 “Swagger” 容易装错旧包(比如 Swashbuckle),必须搜全名 Swashbuckle.AspNetCore

  • .NET 5 项目只能用 Swashbuckle.AspNetCore 5.6.3;装 6.x 会报 NU1202: Package is not compatible with net5.0
  • .NET 6/7 项目推荐 6.5.0+;.NET 8 项目建议用 7.0.0+(截至 2026 年 4 月,7.0.0 是最稳的 LTS 兼容版)
  • 检查目标框架:dotnet --list-sdks.csproj 中的 <targetframework></targetframework> 必须一致

Program.cs 里三处注册缺一不可且顺序敏感

AddSwaggerGen() 只负责“生成文档结构”,不调 UseSwagger() 就没有 /swagger/v1/swagger.json 端点;不调 UseSwaggerUI() 就没有网页界面。中间件顺序错了也会白配。

C函数速查手册(CHM版)
C函数速查手册(CHM版)

C函数速查手册(CHM版)

下载
  • builder.Services.AddSwaggerGen() 放在 AddControllers() 之后、AddEndpointsApiExplorer() 之前(.NET 6+ 必须显式加这句)
  • app.UseSwagger() 必须在 app.UseRouting() 之后、app.UseEndpoints()app.MapControllers() 之前
  • app.UseSwaggerUI(c => c.SwaggerEndpoint(...)) 要紧挨着 UseSwagger(),别被 UseAuthentication() 之类中间件隔开

Controller 参数显示为 object?多半是 XML 注释没对齐

Swagger 默认靠反射读取 DTO 属性,但若属性非 public、没 getter/setter(或只用 init 但项目是 .NET 5)、XML 注释路径没配对,就会退化成 object,字段结构完全丢失。

  • .csproj 里加:<generatedocumentationfile>true</generatedocumentationfile>
  • AddSwaggerGen() 里补上:c.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, $"{Assembly.GetExecutingAssembly().GetName().Name}.xml"))
  • DTO 所有要暴露的字段必须是 public,且至少有一个可访问的 setter(init 在 .NET 6+ 可用,.NET 5 不行)
  • 控制器方法上加 [HttpGet] 等 HTTP 特性,类上加 [ApiController],否则 SwaggerGen 扫描不到

Swagger UI 页面空白或 404 的真实原因

不是“Swagger 没启动”,而是请求路径被拦截或文档未生成。浏览器打开 /swagger 返回 404,说明 UseSwagger() 没注册或被前置中间件吞了;页面加载但没接口,大概率是 SwaggerDoc("v1", ...) 没调,或控制器路由没启用(MapControllers() 缺失)。

  • 先手动访问 /swagger/v1/swagger.json:能打开 JSON 就说明生成成功,问题出在 UI 渲染;打不开就是 UseSwagger() 没生效
  • 检查控制器是否启用路由:app.MapControllers()app.UseEndpoints(e => e.MapControllers()) 必须存在
  • 开发环境外发布时,XML 文件不会自动拷到输出目录,得手动加 <copytooutputdirectory>PreserveNewest</copytooutputdirectory>.csproj

最常被忽略的一点:Swagger 文档不是静态快照,它每次请求都动态反射当前程序集。所以改了 DTO 属性但没重启应用,文档还是旧的;加了新接口但没加 HTTP 特性,它就永远“看不见”。别查缓存,查代码本身是否满足反射前提。

相关专题

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

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

2023.08.08

528

5

什么是c#
什么是c#

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

2023.08.31

1157

3

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

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

2024.03.13

556

8

C#Task用法
C#Task用法

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

2024.03.14

1050

11

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

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

2026.02.03

148

18

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

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

2026.02.06

202

20

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

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

2026.03.11

526

24

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

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

2026.04.13

137

20

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
RabbitMQ 教程手册
RabbitMQ 教程手册

共0课时 | 0人学习

Linux man-pages 项目
Linux man-pages 项目

共0课时 | 0人学习

C# 教程
C# 教程

共94课时 | 20.2万人学习