现在多数的项目开发中，网站和移动端都需要进行数据交互和对接，这少不了使用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） 

Restful api测试插件Swagger-UI的更多相关文章

  1. Chrome Restful Api 测试工具 Postman-REST-Client离线安装包下载，Axure RP Extension for Chrome离线版下载

    [Postman for Chrome 离线下载] Postman-REST-Client离线安装包,可直接在Chrome浏览器本地安装使用,可模拟各种http请求,Restful Api测试, CS ...

  2. Hitchhiker 是一款开源的 Restful Api 测试工具

    Hitchhiker 是一款开源的 Restful Api 测试工具 开源API测试工具 Hitchhiker v0.4更新 - 没有做不到,只有想不到 Hitchhiker 是一款开源的 Restf ...

  3. 使用JMeter进行RESTful API测试

    使用JMeter进行RESTful API测试 在哪里设置实现最优脚本重用的属性 由于支持云的应用程序通常可以轻松.快速地进行复制和部署,所以可以在多种环境中对其进行测试.如果您需要在多个环境中测试和 ...

  4. gRPC helloworld service, RESTful JSON API gateway and swagger UI

    概述 本篇博文完整讲述了如果通过 protocol buffers 定义并启动一个 gRPC 服务,然后在 gRPC 服务上提供一个 RESTful JSON API 的反向代理 gateway,最后 ...

  5. rest-assured : Restful API 测试利器 - 真正的黑盒单元测试（跟Spring-Boot更配哦,更新至spring-boot1.4.1）

    { "Author":"tomcat and jerry", "URL" :"http://www.cnblogs.com/tom ...

  6. 架构实战项目心得（十四）：spring-boot结合Swagger2构建RESTful API测试体系

    一.添加依赖: <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-s ...

  7. RESTful API测试工具

    Postman Postman是一个Chrome APP,可以直接通过Chrome商店安装(需F墙,推荐修改hosts的方法,简便快捷有效) 其截图如下,非常漂亮 Aoizza Web APP,点击访 ...

  8. 带你入门带你飞Ⅱ 使用Mocha + Chai + SuperTest测试Restful API in node.js

    目录 1. 简介 2. 准备开始 3. Restful API测试实战 Example 1 - GET Example 2 - Post Example 3 - Put Example 4 - Del ...

  9. WebApi生成在线API文档--Swagger

    1.前言 1.1 SwaggerUI SwaggerUI 是一个简单的Restful API 测试和文档工具.简单.漂亮.易用(官方demo).通过读取JSON 配置显示API. 项目本身仅仅也只依赖 ...

随机推荐

  1. php新手：XAMMP打开开源php代码

    1.启动XAMPP 打开XAMPP启动 Apache 和 MySql 如果发现默认的80端口被IIS占用了 请参考 这个  如何改变apache被占用的端口 2.将源代码复制到 磁盘(XAMPP安装目 ...

  2. ThinkPHP中PATHINFO模式优化

    ThinkPHP 3.1.2官方手册 第16.2章节 <隐藏index.php>中提到在Ngnix中隐藏index.php实现SEO友好的方法,其中使用了如下的代码 location / ...

  3. WCF-Configuration

    Host-Configuration <?xml version="1.0"?> <configuration> <configSections> ...

  4. linux内核中的get_user和put_user

    linux内核中的get_user和put_user 在 内核空间和用户空间交换数据时,get_user和put_user是两个两用的函数.相对于copy_to_user和 copy_from_use ...

  5. 解决sublime text 2总是在新窗口中打开文件

    在mac下不是很喜欢sublime text 2 总是在新窗口中打开文件,很麻烦,文件打多了,就会出现N多窗口,虽然可以直接打开当前目录可以解决,但有时候查看其它项目中的单个文件,就比较麻烦.百度一直 ...

  6. MVC的小知识点

    1.MVC的前台页面编译完之后,也会生成一个前台页面类.在前天页面中加入这段代码this.GetType().Assembly.GetLocation()得到当前类所在的程序集,可以查看其所在的程序, ...

  7. iTween基础之Look（使对象面朝指定位置）

    一.基础介绍:二.基础属性 原文地址:http://blog.csdn.net/dingkun520wy/article/details/50578142 一.基础介绍 LookTo:旋转游戏对象使其 ...

  8. Ubuntu下的网络配置（USTC）

    1. 配置静态ip      ubuntu的网络配置信息放在 /etc/network/interfaces 中 sudo gedit /etc/network/interfacesauto lo 下 ...

  9. php缓存

    APC缓存退出舞台,APCU诞生,OPCACHE升级! 对于php5.5以后的新版本开发,使用apc习惯的开发者可能会发现php.5.5以后找不到了这个组件的更新,尤其是中文phper都找不到合适的资 ...

  10. ios 开发常用快捷键

    CTRL + K 删除一行,尽量在行首处使用: CMD+ /  注释,取消注释 CMD + R  运行 CMD + . 停止运行 CMD + F   普通搜索 CMD + CTRL + ↑/↓ 切换头 ...