ASP.NET Web API 使用Swagger生成在线帮助测试文档
2015-11-04 14:36
901 查看
转载自:http://www.cnblogs.com/yxlblogs/p/4075932.html
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
5.浏览地址:http://localhost:50453/swagger/ui/index.html就可以看到了
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就可以看到了
相关文章推荐
- 2015-11-04 报表 (asp.net 部分)
- ASP.NET Web Api 2 接口API文档美化之Swagger
- JasperRunManager cannot be resolved
- Detailed ASP.NET MVC Pipeline
- ASP用户登录代码
- Barcode Professional for ASP.NET使用教程:条码图像保存到数据库或者XML文件
- .NET, ASP.NET, CLR版本问题总结
- Not found in 'org.owasp.esapi.resources' directory or file not readable
- asp.net(c#) linkbutton CommandArgument
- ASP.NET中EVAL用法大全
- asp.net TemplateField模板中的Bind方法和Eval方法
- Asp.net2.0水晶报表(CrystalReports)事例源码大全(C#)VS2005版本
- asp.net正则表达式过滤标签和数据提取
- ASP.NET MVC - 定制属于你自己的ViewEngine
- 2015-11-04 asp.net 弹出式日历控件 选择日期 Calendar控件
- Pro ASP.NET MVC –第五章 使用Razor
- asp.net 关于列表问题。点击文章标题,显示文章内容。
- ASP.NET和PHP全面对比
- 安装虚拟机出现Kaspersky Internet Security
- OWASP Webgoat 安装和使用