讲师中心 微信公众号
AI工具推荐 视频效率加速

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

浅静大大_2079

浅静大大_2079

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

|

281人浏览过

|

来源于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里设<generatedocumentationfile>true</generatedocumentationfile>),再在Program.cs中调用AddSwaggerGen时用c.IncludeXmlComments加载。

  • 类/方法顶部的/// <summary>xxx</summary> → 显示为接口标题下方的简短说明
  • /// <remarks>xxx</remarks> → 在“Description”区域显示补充信息,支持换行和简单HTML(如<p><b></b></p>)
  • 参数用/// <param name="id">用户ID,必须大于0 → 对应显示在Parameters表格的Description列

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

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

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

arcgis-js
arcgis-js

提供 ArcGIS Maps SDK for JavaScript 开发辅助,涵盖 2D/3D 地图视图、图层管理、数据可视化、空间分析等功能模块的参考和示例指导。

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

响应示例不显示?检查[ProducesResponseType]是否带Type和Description

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

必须显式指定返回类型:

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

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

XML注释被当作XML解析,如果<summary></summary>里写了if (x ,会导致XML加载失败,整个注释丢失——Swagger UI里就彻底看不到说明了,且无任何错误提示。

解决方案只有两个:

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

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

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

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

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

2235

2023.08.07

json是什么
json是什么

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

3582

2023.08.23

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

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

1196

2023.10.13

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

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

4119

2025.09.10

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

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

4884

2024.04.01

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

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

6337

2024.08.01

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

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

2562

2024.11.28

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

1838

2023.08.03

Uvicorn 报错与问题解决教程
Uvicorn 报错与问题解决教程

本专题汇总了Uvicorn服务器常见问题与报错解决的教程合集,涵盖启动失败、端口占用、模块导入错误、事件循环冲突及热重载失效等典型故障的排查思路。同时整理了多进程与Worker配置、SSL/HTTPS证书报错、跨域与代理配置等实战解决方案,助你快速定位并解决Uvicorn运行中的各类问题。

0

2026.11.02

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
GDB 17.2 官方文档集合
GDB 17.2 官方文档集合

共0课时 | 0人学习

Bootstrap 入门安装配置
Bootstrap 入门安装配置

共0课时 | 0人学习

38+ PhpStorm 提示和技巧
38+ PhpStorm 提示和技巧

共1课时 | 230人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn