swagger添加接口注释

最新推荐文章于 2025-03-19 14:24:03 发布

体育界的扛霸子

最新推荐文章于 2025-03-19 14:24:03 发布

阅读量784

点赞数

分类专栏：后端文章标签： c#

本文链接：https://blog.youkuaiyun.com/qq_42243005/article/details/129316087

版权

后端专栏收录该内容

9 篇文章

订阅专栏

通过在项目属性中勾选生成XML文档，然后在ConfigureServices配置中读取并处理XML文件，可以实现Swagger接口注释的添加。借助自定义的帮助类AppSetting和FileHelper，程序能找到并包含工程中的XML文件，从而在运行时展示接口详细信息。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

右键项目- 属性 - 生成 - 勾选XML文档文件

保存后重新运行一下项目，会生成一个XML文件

在ConfigureServices里面需要再配置一段话

  string xmlFile = AppSetting.GetConfiguration("Startup.Swagger.XmlFiles");
                List<string> xmlFiles = xmlFile.CombineList(",");
                if (xmlFiles.Any())
                {
                    xmlFiles.ForEach(xmlFile =>
                    {
                        if (!string.IsNullOrWhiteSpace(xmlFile))
                        {
                            string xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                            if (FileHelper.FileExists(xmlPath))
                            {
                                options.IncludeXmlComments(xmlPath, true);
                            }
                        }
                    });
                }

再次运行就能得到我们想要的weagger接口注释了