0

0

C# Swagger UI自定义方法 C#如何为API文档添加说明和示例

月夜之吻

月夜之吻

发布时间:2026-02-03 09:45:10

|

181人浏览过

|

来源于php中文网

原创

Swagger UI方法无说明需用/// 和添加XML注释,启用GenerateDocumentationFile并调用IncludeXmlComments;请求体示例推荐实现IExamplesProvider接口;响应示例须用ProducesResponseType(typeof(T))显式指定类型。

c# swagger ui自定义方法 c#如何为api文档添加说明和示例

Swagger UI里方法没说明?用[Summary][Remarks]补上

Swagger UI默认只显示方法名和参数名,不展示业务含义。C#中需在控制器方法或参数上加XML注释,并启用Swagger的XML文档解析。

关键点:注释必须是///格式,且项目要生成XML文件(在.csproj里设true),再在Program.cs中调用AddSwaggerGen时用c.IncludeXmlComments加载。

  • 类/方法顶部的/// xxx → 显示为接口标题下方的简短说明
  • /// xxx → 在“Description”区域显示补充信息,支持换行和简单HTML(如

  • 参数用/// 用户ID,必须大于0 → 对应显示在Parameters表格的Description列

想让请求体带示例JSON?给DTO加[SwaggerSchema][SwaggerRequestExample]

默认情况下,Swagger对POST/PUT的body只显示字段名和类型,没有结构化示例。原生Swashbuckle不直接支持请求体示例,需引入Swashbuckle.AspNetCore.Filters包并注册过滤器。

更轻量的做法是用[SwaggerSchema(Example = @"{""name"":""test""}")]直接写死示例字符串(仅适用于简单类型),但对复杂对象容易出错;推荐方式是实现IExamplesProvider接口,返回强类型的YourDto实例,Swagger会自动序列化为JSON示例。

  • 必须在AddSwaggerGen后调用c.ExampleFilters()
  • 控制器方法上加[SwaggerRequestExample(typeof(YourDto), typeof(YourDtoExampleProvider))]
  • 示例提供者里返回new YourDto { Name = "demo", Age = 25 },比硬编码JSON字符串更安全、可测试

响应示例不显示?检查[ProducesResponseType]是否带TypeDescription

Swagger不会自动推断Task的返回内容。如果只写[ProducesResponseType(StatusCodes.Status200OK)],UI里Response部分就只显示“200 OK”,没有模型结构和示例。

Booltool
Booltool

常用AI图片图像处理工具箱

下载

必须显式指定返回类型:

  • [ProducesResponseType(typeof(UserDto), StatusCodes.Status200OK)] → 让Swagger识别响应模型
  • 配合[SwaggerResponseExample](同请求示例逻辑)可定制200/400/500等不同状态码的返回示例
  • 若方法可能返回多种类型(如Ok()NotFound()),每个[ProducesResponseType]都要单独标注,否则对应状态码的响应区域为空

中文乱码、特殊字符不渲染?XML注释里别用未转义的>

XML注释被当作XML解析,如果

里写了if (x ,会导致XML加载失败,整个注释丢失——Swagger UI里就彻底看不到说明了,且无任何错误提示。

解决方案只有两个:

  • zuojiankuohaophpcn代替youjiankuohaophpcn代替>(注意是&不是&
  • 或者把整段代码块包在...标签里,它会自动转义(但仅限标签内)

这个坑特别隐蔽:编译不报错,运行时Swagger也不报错,只是静默丢弃注释。一旦发现说明消失,第一反应该查XML注释里的尖括号。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

425

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

538

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

313

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

78

2025.09.10

if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

788

2023.08.22

pdf怎么转换成xml格式
pdf怎么转换成xml格式

将 pdf 转换为 xml 的方法:1. 使用在线转换器;2. 使用桌面软件(如 adobe acrobat、itext);3. 使用命令行工具(如 pdftoxml)。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1907

2024.04.01

xml怎么变成word
xml怎么变成word

步骤:1. 导入 xml 文件;2. 选择 xml 结构;3. 映射 xml 元素到 word 元素;4. 生成 word 文档。提示:确保 xml 文件结构良好,并预览 word 文档以验证转换是否成功。想了解更多xml的相关内容,可以阅读本专题下面的文章。

2095

2024.08.01

xml是什么格式的文件
xml是什么格式的文件

xml是一种纯文本格式的文件。xml指的是可扩展标记语言,标准通用标记语言的子集,是一种用于标记电子文件使其具有结构性的标记语言。想了解更多相关的内容,可阅读本专题下面的相关文章。

1092

2024.11.28

Python 序列化
Python 序列化

本专题整合了python序列化、反序列化相关内容,阅读专题下面的文章了解更多详细内容。

12

2026.02.02

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.2万人学习

AngularJS教程
AngularJS教程

共24课时 | 3.3万人学习

CSS教程
CSS教程

共754课时 | 26.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号