Swagger api方法中文注释

最新推荐文章于 2025-05-25 14:11:37 发布

原创最新推荐文章于 2025-05-25 14:11:37 发布 · 742 阅读

1 ·

CC 4.0 BY-SA版权

.NET9527

文章标签：

#c#

C# 同时被 2 个专栏收录

53 篇文章

订阅专栏

.NET COre

18 篇文章

订阅专栏

本文介绍如何在 Swagger API 文档中添加中文注释。通过使用 C# 获取 XML 文件并指定其路径，然后将该 XML 文件作为注释源添加到 Swagger 的控制器层，从而实现 API 接口的中文说明。

Swagger api方法中文注释

 // 获取xml文件名
                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                // 获取xml文件路径
                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                // 添加控制器层注释，true表示显示控制器注释
                c.IncludeXmlComments(xmlPath, true);