webapi swagger学习笔记
版权声明:部分摘抄其他博主朋友的博文内容,旨在分享学习,如给您带来不便,请原谅。原文地址 http://www.cnblogs.com/yanweidie/p/5709113.html#_label3
最近做的项目使用mvc+webapi,采取前后端分离的方式,后台提供API接口文档给前端开发人员或app开发人员,另外也方便后台开发人员自己测试。有两种方案,1.微软自带的Microsoft.AspNet.WebApi.HelpPage 2.swagger(戏称为“丝袜哥”)。推荐后者,测试方便。
一、swagger使用步骤
1.创建webapi项目解决方案
2. nugget——安装swashbuckle和swashbuckle.core
3、编写apicontroller及action。
注意书写action的注释。敲“///”快捷键,自动生成summary 注释,填写1处action注释说明,2处参数说明
效果如下 1为controller名称 2为action说明 3为action路由,4为参数 5为参数注释说明
4、 项目——属性——生成——勾选生成xml文档文件
修改SwaggerConfig文件
1、类上面有这句[assembly: PreApplicationStartMethod(typeof(SwaggerConfig), "Register")]
2、
4、将开源代码Swagger文件夹整体拷到项目中
5、配置完成后启动程序http://localhost:10889/Swagger/dist/index.html则呈现接口文档效果
二、swagger使用效果
1.列出所有API控制器和控制器描述
2.列出action和描述
3.直观的接口测试
三、demo代码,见SwaggerWebapiDemo
四、程序发布后查看swagger文档时报500错误,解决方法http://localhost:10889/Swagger/dist/index.html
1、出现这个原因基本是这种情况。发布的程序遗漏了swagger的xml文档。通过项目——属性——生成——生成xml文档文件 查看xml文档地址。复制拷贝到iis对应的文件夹里即可解决
五、程序发布到文件夹或者一键部署到web服务器上,可能会出现遗漏掉xml文件。
则需要设置项目属性——生成时注意1处选择release,下面选生成xml文件。因为发布时选择的配置也是release