系列文章

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较为原始的做法

刚开始我们是使用postman、http、curl等工具去测试的。

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、小幺鸡