ASP.NET Web API 使用Swagger生成在线帮助测试文档
2016-05-26 11:33
896 查看
ASP.NET Web API 使用Swagger生成在线帮助测试文档
Swagger-UI简单而一目了然。它能够纯碎的基于html+javascript实现,只要稍微整合一下便能成为方便的API在线测试工具。项目的设计架构中一直提倡使用TDD(测试驱动)原则来开发,swagger-ui在这方面更是能提供很大帮助。Swagger-UI更倾向于在线测试接口和数据,但其核心是一个javascript插件,只要稍作修改,便能按需求定制出不同格式的说明文档,在github上更是基于它集成到各种语言环境,分支众多。
其官方提供了一个离线版本,它的使用方法十分简单:直接在js格式的资源文件中录入REST API的json信息,便能容易地生成不同模块下的API列表,每个API接口描述和参数、请求方法都能在每个json数组中定制。下面是目前项目中使用到的部分预览图:
在.net中使用
1.NuGet包安装
Install-Package Swashbuckle
2.安装之后会在App_Start文件夹中添加SwaggerConfig.cs类,该类中的Register()方法会在应用程序启动的时候调用
3.启用生成xml文档,右击项目文件属性
4.配置SwaggerConfig.cs
public class SwaggerConfig { public static void Register() { Swashbuckle.Bootstrapper.Init(GlobalConfiguration.Configuration); // NOTE: If you want to customize the generated swagger or UI, use SwaggerSpecConfig and/or SwaggerUiConfig here ... SwaggerSpecConfig.Customize(c => { c.IncludeXmlComments(GetXmlCommentsPath()); }); } protected static string GetXmlCommentsPath() { return System.String.Format(@"{0}\bin\WebApiSwagger.XML", System.AppDomain.CurrentDomain.BaseDirectory); } }
5.浏览地址:http://localhost:50453/swagger/ui/index.html就可以看到了
相关文章推荐
- Asp.Net MVC 4 Web API 中的安全认证-使用OAuth
- ASP.NET Core 开发-中间件(Middleware)
- 微信扫码支付+Asp.Net MVC
- ASP.NET Web API 安全验证之摘要(Digest)认证
- ASP.NET的Cookie和Session
- aspx后台传递Json到前台的两种接收方法推荐
- Asp.Net 操作XML文件的增删改查 利用GridView
- Asp.Net Core-几行代码解决Razor中的嵌套if语句
- 适用于asp.net的一个转盘抽奖源码
- ASP网站挂木马怎么办?
- ASP.NET使用Fileupload时网页报错提示“连接已重置”
- ASP.NET MVC 模块与组件(二)——定制图片验证码
- vs2010 用户控件拖到aspx页面不可用
- 关于asp.net中页面事件加载的先后顺序
- Asp.net 访问数据库的几种方式
- Asp.net 身份验证方式?
- Asp.net MVC 之异常处理
- ASP.NET Core 1.0: Deploy to IIS
- ASP.NET Core 1.0: 指定Static File中的文件作为default page
- 使用JasperReport+iReport进行WEB开发