其他分享
首页 > 其他分享> > .Net Core 的Swagger测试加入XML注释

.Net Core 的Swagger测试加入XML注释

作者:互联网

.Net Core Swagger测试加入XML注释

参考网站:给swagger添加文档注释详细步骤 (icode9.com)

 

没有加入XML注释效果:

 

2、编写代码,对其Swagger加入注释

2-1、右键项目属性,生成下面,对XML文档进行打钩,会自动生成一个xml文档。

 

2-2、右键项目,生成以后,项目下面多出一个xml文件,右键xml文件到属性,选择始终复制。

如果没有点始终复制,将来发布到其他地方时候,有可能不会带出xml文档,轻则swagger不会显示注释,重则页面打开会报错文件丢失等

 

2-3、在Startup文件夹ConfigureServices方法中添加代码

          //swagger加入XML提示 开始
                var baseDirectory = System.AppDomain.CurrentDomain.BaseDirectory;
                var xmlFile = System.AppDomain.CurrentDomain.FriendlyName + ".xml";
                var xmlPath = Path.Combine(baseDirectory, xmlFile);
                c.IncludeXmlComments(xmlPath);
                //swagger加入XML提示 结束

 

2-4、Swagger加入XML注释效果

 

标签:XML,Core,swagger,xml,加入,注释,Net,Swagger
来源: https://www.cnblogs.com/ZhuMeng-Chao/p/16216799.html