作為一名web前端開發(fā)攻城獅,對于接口調(diào)試和接口文檔都不會陌生。任何項目的接口文檔和接口都是前后端,以及產(chǎn)品經(jīng)理溝通協(xié)商出來的產(chǎn)物。
換句話說接口文檔是前后端開發(fā)需要在開發(fā)前期進行接口定義并形成文檔,提供給測試人員在進行功能測試和接口測試的環(huán)節(jié)的依據(jù)和參照。
更重要的使用場景:由于后端接口開發(fā)好,提供接口文檔供前端人員調(diào)用;由于某種原因,修改了接口,文檔沒有及時更新,導(dǎo)致后續(xù)交接或聯(lián)調(diào)時接口文檔不匹配;使用接口文檔自動生成工具,解決這一主要問題。
顯而易見,了解一些常用的和會用接口文檔管理工具,可以讓前端開發(fā)人員開發(fā)工作效率大大的提升。
今天25學(xué)堂跟大家分享五款不錯的在線接口文檔管理工具。
第一款在線接口文檔管理工具:eolinker AMS
eoLinker擁有業(yè)內(nèi)最強的接口管理功能,無論您是創(chuàng)業(yè)團隊還是成熟企業(yè),我們都能滿足您所有的需求,最重要的是,它是免費且開源的!
2017年10月底,eoLinker榮獲第六屆中國創(chuàng)新創(chuàng)業(yè)互聯(lián)網(wǎng)總決賽優(yōu)秀企業(yè)獎!獲得業(yè)界和用戶的大力肯定。
主要有三大主要功能:
1、eoLinker AMS為你帶來清晰的接口文檔管理體驗。
2、編寫或自動生成友好的可視化文檔,并且能夠?qū)涌诘?
3、每次一修改進行歸檔,隨時進行版本回滾。
免費版含有7大功能,日期免費版已更新到了?V3.1.0?
1.?UI可視化文檔
2.?支持表單、RESTful、Raw等設(shè)計規(guī)范
3.?通過注釋生成文檔
4.?版本管理
5.?支持富文本/Markdown
6.?分組管理
7.?星標(biāo)標(biāo)注
被眾多網(wǎng)友稱為一款好用的接口管理工具,詳細(xì)前端開發(fā)文檔:http://www.jianshu.com/p/368633187790
eolinker AMS官網(wǎng)地址:https://www.eolinker.com
第二款在線接口文檔管理工具:DOClever
DOClever提供了項目和團隊兩種協(xié)作模式,您可以在不同的模式間自由的切換,大大提高您的協(xié)作效率。
DOClever獨創(chuàng)的接口業(yè)務(wù)場景的自動化測試功能,并且可以通過后臺輪詢將結(jié)果及時發(fā)送到您的郵箱。
DOClever官網(wǎng)和詳細(xì)使用文檔:
http://doclever.cn/controller/index/index.html
第三款在線接口文檔管理工具:apizza? ——極客專屬的api協(xié)作管理工具
自定義參數(shù)設(shè)置,免費的團隊協(xié)作,在線模擬調(diào)試,快速生成api文檔,導(dǎo)出離線版文檔
真正適用于極客愛好者發(fā)揮的接口文檔管理工具。
官網(wǎng)詳細(xì)了解地址:http://apizza.cc
第四款在線接口文檔管理工具:Postman? 前端工程師都網(wǎng)頁調(diào)試Chrome插件工具
Postman可以將調(diào)試過的請求保存到Collection中。形成的Collection就可以作為一份簡單有效且支持在線測試的接口文檔,使用同一賬號登錄就可以做到分享和同步。對QA來說,使用Postman進行接口測試和接口文檔維護是同一件事情,測試即文檔,維護成本也很低。
Postman 下載:https://pan.baidu.com/s/1eSmqNTo
POSTman官網(wǎng):https://www.getpostman.com/apps
第五款在線接口文檔管理工具:RAP
RAP是阿里的一套完整的可視化接口管理工具,可以定義接口結(jié)構(gòu),動態(tài)生成模擬數(shù)據(jù),校驗真實接口正確性。不僅如此,RAP圍繞接口定義,提供了一系列包括團隊管理、項目管理、文檔版本管理、mock插件等服務(wù)。
git下載地址:http://rap.taobao.org/org/index.do
RAP的本地搭建過程如下:
1. 本地服務(wù)準(zhǔn)備:Tomcat、Redis、Mysql;
2. Github上下載RAP最新的war包,部署war包到Tomcat/webapps/ROOT目錄下;
3. 修改數(shù)據(jù)庫配置文件:ROOT/WEB-INF/classes/config.properties,修改為本地數(shù)據(jù)庫的連接信息;
4. 數(shù)據(jù)庫初始化:在本地數(shù)據(jù)庫上執(zhí)行ROOTWEB-INFclassesdatabase中的initialize.sql;
5. 開啟tomcat、redis、mysql服務(wù),瀏覽器訪問http://localhost:8080/。
以上就是今天25學(xué)堂想要跟大家推薦的五款WEB前端工程師高效的在線接口文檔管理工具。方便大家在工作之中好好利用這些成熟的在線接口文檔管理工具,讓工作事半功倍。
全站高品質(zhì)素材免費下載!