C#怎么使用Swagger生成API文档_C# Swashbuckle配置教程【常用】

大婷吖_7454

大婷吖_7454

2026-05-18

290人浏览

原创

swagger在c#中需通过swashbuckle.aspnetcore完整配置:addswaggergen生成json、useswagger暴露json、useswaggerui渲染页面,三者缺一不可且顺序严格;版本须匹配.net框架(如.net 8用7.0.0+),并正确启用xml注释与特性解析。

c#怎么使用swagger生成api文档_c# swashbuckle配置教程【常用】

Swagger 在 C# 里不是装个包就自动出文档的功能,它必须靠 Swashbuckle.AspNetCore 包完成三件事:生成 JSON(AddSwaggerGen)、暴露该 JSON(UseSwagger)、渲染成网页(UseSwaggerUI)。漏掉任意一环,/swagger 页面就是 404、空白,或参数全显示为 object。

Swashbuckle.AspNetCore 版本和 .NET 框架不匹配直接报错

装不上或运行时报 NU1202: Package is not compatible with netX.0,基本就是版本对不上。NuGet 搜 “Swagger” 容易误装旧包 Swashbuckle,必须搜全名 Swashbuckle.AspNetCore。

  • .NET 5 项目只能用 Swashbuckle.AspNetCore 5.6.3
  • .NET 6/7 项目推荐 6.5.0 或更高(如 6.6.2)
  • .NET 8 项目建议用 7.0.0 及以上(截至 2026 年 4 月,7.0.0 是最稳的 LTS 兼容版)
  • 检查目标框架:dotnet --list-sdks 和 .csproj 中的 <targetframework></targetframework> 必须一致

AddSwaggerGen + UseSwagger + UseSwaggerUI 缺一不可且顺序敏感

只调 AddSwaggerGen() 不会生成可访问的 JSON;只调 UseSwagger() 不会加载 UI;中间件顺序错了,Swagger 就被路由或认证中间件拦住。

C#
C#

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

下载
  • builder.Services.AddEndpointsApiExplorer() 必须在 AddSwaggerGen() 之前(.NET 6+ 显式要求)
  • app.UseSwagger() 必须在 app.UseRouting() 之后、app.UseEndpoints() 或 app.MapControllers() 之前
  • app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API v1")) 要紧挨着 UseSwagger(),别被 UseAuthentication() 等隔开
  • AddSwaggerGen() 里至少得写 c.SwaggerDoc("v1", new OpenApiInfo { Title = "...", Version = "v1" }),否则没文档根节点

Controller 参数显示为 object?XML 注释根本没加载成功

写了 /// <summary>xxx</summary> 却没出现在 Swagger UI 里,90% 是 XML 文件压根没生成,或生成了但路径不对、没注册进 AddSwaggerGen。

  • .csproj 中加:<generatedocumentationfile>true</generatedocumentationfile>
  • AddSwaggerGen() 里必须显式调 c.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, "YourApp.xml")),文件名默认是程序集名+.xml,大小写敏感
  • 发布后检查输出目录(如 publish/YourApp.xml)是否真有该文件,Debug 目录下有 ≠ 发布后也有
  • DTO 所有字段必须是 public,且带 getter(init 在 .NET 6+ 可用,.NET 5 不行);private 字段、只读属性、无 setter 的 init(低版本)都会退化为 object

ProducesResponseType 不显示模型?响应类型推导没打开

加了 [ProducesResponseType(typeof(User), StatusCodes.Status200OK)],但 Swagger UI 里 Response Body 还是空或显示 object,问题常出在 Swagger 没启用特性解析。

  • AddSwaggerGen() 配置里要加 c.EnableAnnotations()(启用 ProducesResponseType 和 SwaggerResponseAttribute)
  • 返回类型别用模糊写法,比如 IEnumerable<user></user> 或 Task<iresult></iresult>,Swagger 推断容易失败;显式写成 [ProducesResponseType(typeof(IEnumerable<user>), 200)]</user>
  • 如果用了泛型或继承结构,考虑补上 c.UseOneOfForPolymorphism()
  • 控制器类必须标 [ApiController],方法必须有 HTTP 特性(如 [HttpGet]),否则 AddSwaggerGen 根本扫描不到这个接口

最常被忽略的点:XML 注释路径是运行时路径,不是编译时路径;AppContext.BaseDirectory 在 IIS、Docker、Azure App Service 下可能和你本地调试时不一样,硬编码路径极易失效。建议用 Assembly.GetExecutingAssembly().GetName().Name + ".xml" 拼接,并加日志验证文件是否存在。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

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

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

下载

相关标签:

c#

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

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3009

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2268

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1200

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1158

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1336

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2098

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3320

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

14875

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

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

精品课程

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

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

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

共0课时 | 0人学习