五款WEB前端工程師高效的在線(xiàn)接口文檔管理工具

作為一名web前端開(kāi)發(fā)攻城獅,對(duì)于接口調(diào)試和接口文檔都不會(huì)陌生。任何項(xiàng)目的接口文檔和接口都是前后端,以及產(chǎn)品經(jīng)理溝通協(xié)商出來(lái)的產(chǎn)物。

換句話(huà)說(shuō)接口文檔是前后端開(kāi)發(fā)需要在開(kāi)發(fā)前期進(jìn)行接口定義并形成文檔,提供給測(cè)試人員在進(jìn)行功能測(cè)試和接口測(cè)試的環(huán)節(jié)的依據(jù)和參照。

更重要的使用場(chǎng)景:由于后端接口開(kāi)發(fā)好,提供接口文檔供前端人員調(diào)用;由于某種原因,修改了接口,文檔沒(méi)有及時(shí)更新,導(dǎo)致后續(xù)交接或聯(lián)調(diào)時(shí)接口文檔不匹配;使用接口文檔自動(dòng)生成工具,解決這一主要問(wèn)題。

顯而易見(jiàn),了解一些常用的和會(huì)用接口文檔管理工具,可以讓前端開(kāi)發(fā)人員開(kāi)發(fā)工作效率大大的提升。

 

今天25學(xué)堂跟大家分享五款不錯(cuò)的在線(xiàn)接口文檔管理工具。

 

第一款在線(xiàn)接口文檔管理工具:eolinker AMS

eoLinker擁有業(yè)內(nèi)最強(qiáng)的接口管理功能,無(wú)論您是創(chuàng)業(yè)團(tuán)隊(duì)還是成熟企業(yè),我們都能滿(mǎn)足您所有的需求,最重要的是,它是免費(fèi)且開(kāi)源的!

eolinker

2017年10月底,eoLinker榮獲第六屆中國(guó)創(chuàng)新創(chuàng)業(yè)互聯(lián)網(wǎng)總決賽優(yōu)秀企業(yè)獎(jiǎng)!獲得業(yè)界和用戶(hù)的大力肯定。

主要有三大主要功能:

1、eoLinker AMS為你帶來(lái)清晰的接口文檔管理體驗(yàn)。

2、編寫(xiě)或自動(dòng)生成友好的可視化文檔,并且能夠?qū)涌诘?

3、每次一修改進(jìn)行歸檔,隨時(shí)進(jìn)行版本回滾。

 

免費(fèi)版含有7大功能,日期免費(fèi)版已更新到了?V3.1.0?

1.?UI可視化文檔

2.?支持表單、RESTful、Raw等設(shè)計(jì)規(guī)范

3.?通過(guò)注釋生成文檔

4.?版本管理

5.?支持富文本/Markdown

6.?分組管理

7.?星標(biāo)標(biāo)注

被眾多網(wǎng)友稱(chēng)為一款好用的接口管理工具,詳細(xì)前端開(kāi)發(fā)文檔:http://www.jianshu.com/p/368633187790

eolinker AMS官網(wǎng)地址:https://www.eolinker.com

 

 

第二款在線(xiàn)接口文檔管理工具:DOClever

DOClever提供了項(xiàng)目和團(tuán)隊(duì)兩種協(xié)作模式,您可以在不同的模式間自由的切換,大大提高您的協(xié)作效率。

DOClever獨(dú)創(chuàng)的接口業(yè)務(wù)場(chǎng)景的自動(dòng)化測(cè)試功能,并且可以通過(guò)后臺(tái)輪詢(xún)將結(jié)果及時(shí)發(fā)送到您的郵箱。

doclever

DOClever官網(wǎng)和詳細(xì)使用文檔:

http://doclever.cn/controller/index/index.html

 

 

第三款在線(xiàn)接口文檔管理工具:apizza? ——極客專(zhuān)屬的api協(xié)作管理工具

自定義參數(shù)設(shè)置,免費(fèi)的團(tuán)隊(duì)協(xié)作,在線(xiàn)模擬調(diào)試,快速生成api文檔,導(dǎo)出離線(xiàn)版文檔

真正適用于極客愛(ài)好者發(fā)揮的接口文檔管理工具。

apizza

 

官網(wǎng)詳細(xì)了解地址:http://apizza.cc

 

第四款在線(xiàn)接口文檔管理工具:Postman? 前端工程師都網(wǎng)頁(yè)調(diào)試Chrome插件工具

Postman可以將調(diào)試過(guò)的請(qǐng)求保存到Collection中。形成的Collection就可以作為一份簡(jiǎn)單有效且支持在線(xiàn)測(cè)試的接口文檔,使用同一賬號(hào)登錄就可以做到分享和同步。對(duì)QA來(lái)說(shuō),使用Postman進(jìn)行接口測(cè)試和接口文檔維護(hù)是同一件事情,測(cè)試即文檔,維護(hù)成本也很低。

postman

Postman 下載:https://pan.baidu.com/s/1eSmqNTo

POSTman官網(wǎng):https://www.getpostman.com/apps

 

第五款在線(xiàn)接口文檔管理工具:RAP

RAP是阿里的一套完整的可視化接口管理工具,可以定義接口結(jié)構(gòu),動(dòng)態(tài)生成模擬數(shù)據(jù),校驗(yàn)真實(shí)接口正確性。不僅如此,RAP圍繞接口定義,提供了一系列包括團(tuán)隊(duì)管理、項(xiàng)目管理、文檔版本管理、mock插件等服務(wù)。

WEB工程師更高效的管理接口文檔

git下載地址:http://rap.taobao.org/org/index.do

RAP的本地搭建過(guò)程如下:

1. 本地服務(wù)準(zhǔn)備:Tomcat、Redis、Mysql;

2. Github上下載RAP最新的war包,部署war包到Tomcat/webapps/ROOT目錄下;

3. 修改數(shù)據(jù)庫(kù)配置文件:ROOT/WEB-INF/classes/config.properties,修改為本地?cái)?shù)據(jù)庫(kù)的連接信息;

4. 數(shù)據(jù)庫(kù)初始化:在本地?cái)?shù)據(jù)庫(kù)上執(zhí)行ROOTWEB-INFclassesdatabase中的initialize.sql;

5. 開(kāi)啟tomcat、redis、mysql服務(wù),瀏覽器訪(fǎng)問(wèn)http://localhost:8080/。

 

以上就是今天25學(xué)堂想要跟大家推薦的五款WEB前端工程師高效的在線(xiàn)接口文檔管理工具。方便大家在工作之中好好利用這些成熟的在線(xiàn)接口文檔管理工具,讓工作事半功倍。

每天更新,
全站高品質(zhì)素材免費(fèi)下載!