Swagger-UI 基于REST的API测试/文档类插件

现在多数的项目开发中，网站和移动端都需要进行数据交互和对接，这少不了使用REST编写API接口这种场景。例如我目前的工作，移动端交由了另一团队开发，不同开发小组之间就需要以规范和文档作为标准和协作基础。良好的文档可以让开发事半功倍，而作为又懒又要效率又能交代的码农，当然最希望一切自动化，或用小聪明来找到最适合的工具。

Swagger-UI简单而一目了然。它能够纯碎的基于html+javascript实现，只要稍微整合一下便能成为方便的API在线测试工具。项目的设计架构中一直提倡使用TDD（测试驱动）原则来开发，swagger-ui在这方面更是能提供很大帮助。

Swagger-UI更倾向于在线测试接口和数据，但其核心是一个javascript插件，只要稍作修改，便能按需求定制出不同格式的说明文档，在github上更是基于它集成到各种语言环境，分支众多。

其官方提供了一个离线版本，它的使用方法十分简单：直接在js格式的资源文件中录入REST API的json信息，便能容易地生成不同模块下的API列表，每个API接口描述和参数、请求方法都能在每个json数组中定制。下面是目前项目中使用到的部分预览图：





Swagger-UI 的官方地址：

http://swagger.wordnik.com

Github上的项目地址：

https://github.com/wordnik/swagger-ui

官方提供的demo地址

http://petstore.swagger.wordnik.com/

------------------------------------------

2012年10月19日更新：

下面是自己目前修改后的demo：

1. 添加了window.swaggerUi 中的几个参数（说明文件），更方便资源文件的编写

2. 修复了测试时post方法的bug

3. 界面显示中文

4. 根据每个接口的更新情况，定制了一些修订说明

附件（swagger-ui-editby-ekin.zip）

评论

10 楼 u013768076 2016-12-01  

9 楼 静之恒v 2016-07-14  

请问swagger在发送POST请求有BUG，要如何修改，在其他地方看到你说：注释掉swagger-ui.js文件中的一行，请问是哪一行呢，谢谢。

8 楼 f756692193 2016-01-15  

看了说明，还是不知道怎么使用啊

7 楼 f756692193 2016-01-15  

whfandtank 写道

有本地的demo嘛，简单定义好的

同求

6 楼 zwsong 2015-11-25  

5 楼 whfandtank 2015-05-05  

有本地的demo嘛，简单定义好的

4 楼 ron.luo 2014-12-29  

请问下，swagger-ui-editby-ekin.zip这个不整合到系统中，单独使用吗？

3 楼 ron.luo 2014-08-24  

怎么部署测试呢？

2 楼 ron.luo 2014-08-04  

很牛逼啊，大赞。

1 楼 huaganshang 2013-06-24  

您好，是不是还需要指定自己的api-key