SwaggerUIASP.NetWebAPI2-创新互联-成都创新互联网站建设

关于创新互联

多方位宣传企业产品与服务 突出企业形象

公司简介 公司的服务 荣誉资质 新闻动态 联系我们

SwaggerUIASP.NetWebAPI2-创新互联

目前在用ASP.NET的 WebAPI2来做后台接口开发,在与前台做测试的时候,总是需要发送一个demo给他,但是这样很麻烦的,他还有可能记不住。

成都创新互联公司是一家专注于成都网站设计、网站制作与策划设计,四方台网站建设哪家好?成都创新互联公司做网站,专注于网站建设10余年,网设计领域的专业建站公司;建站业务涵盖:四方台等地区。四方台做网站价格咨询:13518219792

然后就想到SwaggerUI 生成测试文档。

话不多说,来看看它的具体用法吧!

第一步:

在VS2015(后者是你自己的工具里)打开程序包管理控制台输入:

Install-Package Swashbuckle

等待安装,完成后会发现,在App_Start文件夹下会多出来一个配置文件SwaggerConfig.cs

SwaggerUI ASP.Net WebAPI2

第二步:

打开这个文件然后找到Register()方法里的c.IncludeXmlComments(),增加一个参数,也就是说改成c.IncludeXmlComments(GetXmlCommentsPath(thisAssembly.GetName().Name));

然后在跟Register方法平级的地方增加一个方法

protected static string GetXmlCommentsPath(string name)
        {            return string.Format(@"{0}\bin\{1}.XML", AppDomain.CurrentDomain.BaseDirectory, name);
        }

然后配置文件到此结束,

第三步:

继续做对于项目的配置

SwaggerUI ASP.Net WebAPI2

右键项目->属性->生成->勾选(XML文档文件)->点击保存文件即可。

第四步:

输入访问路径

http://localhost:15416/swagger/ui/index

这里边关于主机和端口需要替换成寄几的。

最后成果

SwaggerUI ASP.Net WebAPI2

这里做个备注,发现每个请求后边都会有注释,而且点开以后也有注释,这个就是你在你的接口中的注释,它可以直接拿过来显示的。

SwaggerUI ASP.Net WebAPI2

/// /// 发送手机验证码/// /// 手机号

参考:http://www.cnblogs.com/fangwei0505/p/6398382.html

同时放上SpringMVC的Demo:http://blog.csdn.net/u01149×××/article/details/53455144

额外备注:

就是如果命令行安装错了位置了,就应该执行卸载命令。

Uninstall-Package Swashbuckle

另外有需要云服务器可以了解下创新互联scvps.cn,海内外云服务器15元起步,三天无理由+7*72小时售后在线,公司持有idc许可证,提供“云服务器、裸金属服务器、高防服务器、香港服务器、美国服务器、虚拟主机、免备案服务器”等云主机租用服务以及企业上云的综合解决方案,具有“安全稳定、简单易用、服务可用性高、性价比高”等特点与优势,专为企业上云打造定制,能够满足用户丰富、多元化的应用场景需求。


本文标题:SwaggerUIASP.NetWebAPI2-创新互联
路径分享:http://kswsj.cn/article/dhpoic.html

其他资讯