DevOps第四弹之接口文档与API测试

系列文章

DevOps第零弹之开篇
DevOps第一弹之项目与事务跟踪工具
DevOps第二弹之部署私有Git服务器
DevOps第三弹之效率沟通
DevOps第四弹之接口文档与API测试
DevOps第五弹之持续集成编译环境(Android)
DevOps第五弹之持续集成Jenkins(Android篇)
DevOps第六弹之工具大整合

写在前面

参加团队合作开发有三年多了,其中接口文档进化了很多代。慢慢地各方向之间的沟通从很low的方式变得看起来高大上。
说一下包括前面有一些文章可能比较简单,大多是安装软件和部署环境的。再次说明,本系列文章并不是什么深入研究类型的文章,仅仅是把我知道的一些关于DevOps的东西分享出来,虽是简单,但是不说,很多人也未必知道。

文档进化阶段

V1口口相传的时代

V1版本我们通过大声喊的方式告知对方接口的标准。刚开始有什么不清楚的直接问就好了,但是到了后面的时候连写接口代码的那个人都忘了这接口怎么用,维护成本巨高。

V2使用Word、Pages等文本处理软件

V2

嗯,这时候算是有了记录的功能而已,看起来仍然不够直观。

V3使用Markdown

V3

这是后面使用markdown去编写的接口文档。可以说看起来算是比较直观了。

但是总感觉缺点什么东西。嗯,这东西还不能测试

接口测试

V1较为原始的做法

刚开始我们是使用postmanhttpcurl等工具去测试的。

postman

上面的几个工具都是非常棒的工具,相比后面介绍的一些web交互的工具有更高的自由度,使用也更灵活。

V2使用WEB交互

类似的工具很多,其中Swagger支持的语言比较多,缺点就是需要去学习对应的注解语法。如果是使用Django开发后端的话,那么就有福了。配合REST framework就能很好地去生成对应的WEB页面,包括构建Restful的API也很方便。

Swagger

REST framework1

REST framework2

怎么选择

构建一个接口文档管理平台和API测试平台非常有必要,那么多工具,怎么选?推荐大家使用小幺鸡,支持在线托管这个平台和私有部署。比较好的结合了接口文档管理和API测试平台的功能。

小幺鸡

小幺鸡私有部署

步骤

1、安装tomcat
2、下载小幺鸡war包
3、配置数据库
4、修改配置文件
5、启动

1、安装tomcat

这里选择安装tomcat8.5,官网地址

tomcat

wget http://mirror.bit.edu.cn/apache/tomcat/tomcat-8/v8.5.24/bin/apache-tomcat-8.5.24.zip
unzip apache-tomcat-8.5.24.zip

2、下载小幺鸡war包

我们下载最新的版本,版本选择

wget https://github.com/zhoujingjie/xiaoyaoji/releases/download/2.1.6/xiaoyaoji-2.1.6.1.war
mkdir apache-tomcat-8.5.24/webapps/xiaoyaoji
unzip xiaoyaoji-2.1.6.1.war -d apache-tomcat-8.5.24/webapps/xiaoyaoji/

3、配置数据库

1、创建小幺鸡数据库
2、导入小幺鸡sql脚本

root@iZwz9f0sget2ecg5evg6gfZ:~# wget https://raw.githubusercontent.com/zhoujingjie/xiaoyaoji/dev/doc/xiaoyaoji.sql
root@iZwz9f0sget2ecg5evg6gfZ:~# mysql -u root -p
mysql> create database xiaoyaoji;
mysql> source xiaoyaoji.sql

4、修改配置文件

编辑apache-tomcat-8.5.24/webapps/xiaoyaoji/WEB-INF/classes/config.properties文件
修改mysql账户密码

修改配置文件

5、启动

cd apache-tomcat-8.5.24/bin/
chmod +x *.sh
./startup.sh

访问http://120.78.191.35:8080/xiaoyaoji/就ok了

私有部署小幺鸡

总结

接口文档:口述、Word、Markdown、小幺鸡
接口测试:curl、http、postman、swagger、eolinker、nei、小幺鸡

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,015评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,262评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,727评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,986评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,363评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,610评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,871评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,582评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,297评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,551评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,053评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,385评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,035评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,079评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,841评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,648评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,550评论 2 270

推荐阅读更多精彩内容