系列文章

DevOps第零彈之開篇
DevOps第一彈之項(xiàng)目與事務(wù)跟蹤工具
DevOps第二彈之部署私有Git服務(wù)器
DevOps第三彈之效率溝通
DevOps第四彈之接口文檔與API測試
DevOps第五彈之持續(xù)集成編譯環(huán)境（Android）
DevOps第五彈之持續(xù)集成Jenkins（Android篇）
DevOps第六彈之工具大整合

寫在前面

參加團(tuán)隊(duì)合作開發(fā)有三年多了，其中接口文檔進(jìn)化了很多代。慢慢地各方向之間的溝通從很low的方式變得看起來高大上。
說一下包括前面有一些文章可能比較簡單，大多是安裝軟件和部署環(huán)境的。再次說明，本系列文章并不是什么深入研究類型的文章，僅僅是把我知道的一些關(guān)于DevOps的東西分享出來，雖是簡單，但是不說，很多人也未必知道。

文檔進(jìn)化階段

V1口口相傳的時(shí)代

V1版本我們通過大聲喊的方式告知對方接口的標(biāo)準(zhǔn)。剛開始有什么不清楚的直接問就好了，但是到了后面的時(shí)候連寫接口代碼的那個(gè)人都忘了這接口怎么用，維護(hù)成本巨高。

V2使用Word、Pages等文本處理軟件

V2

嗯，這時(shí)候算是有了記錄的功能而已，看起來仍然不夠直觀。

V3使用Markdown

V3

這是后面使用markdown去編寫的接口文檔?？梢哉f看起來算是比較直觀了。

但是總感覺缺點(diǎn)什么東西。嗯，這東西還不能測試

接口測試

V1較為原始的做法

剛開始我們是使用postman、http、curl等工具去測試的。

postman

V2使用WEB交互

類似的工具很多，其中Swagger支持的語言比較多，缺點(diǎn)就是需要去學(xué)習(xí)對應(yīng)的注解語法。如果是使用Django開發(fā)后端的話，那么就有福了。配合REST framework就能很好地去生成對應(yīng)的WEB頁面，包括構(gòu)建Restful的API也很方便。

Swagger

REST framework1

REST framework2

怎么選擇

構(gòu)建一個(gè)接口文檔管理平臺和API測試平臺非常有必要，那么多工具，怎么選？推薦大家使用小幺雞，支持在線托管這個(gè)平臺和私有部署。比較好的結(jié)合了接口文檔管理和API測試平臺的功能。

小幺雞

小幺雞私有部署

步驟

1、安裝tomcat
2、下載小幺雞war包
3、配置數(shù)據(jù)庫
4、修改配置文件
5、啟動(dòng)

1、安裝tomcat

這里選擇安裝tomcat8.5，官網(wǎng)地址

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、配置數(shù)據(jù)庫

1、創(chuàng)建小幺雞數(shù)據(jù)庫
2、導(dǎo)入小幺雞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、啟動(dòng)

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

訪問http://120.78.191.35:8080/xiaoyaoji/就ok了

私有部署小幺雞

總結(jié)

接口文檔：口述、Word、Markdown、小幺雞
接口測試：curl、http、postman、swagger、eolinker、nei、小幺雞