推薦一款互聯(lián)網(wǎng)大廠最近流行使用的API接口管理神器
API 本質(zhì)是一個(gè)封裝了功能并公開(kāi)一個(gè)用于訪(fǎng)問(wèn)功能的接口！
關(guān)于 API 的信息外界無(wú)從得知，所以沒(méi)有好的文檔，使用者就無(wú)法理解和使用。
API 文檔最核心的需求是簡(jiǎn)潔精準(zhǔn)，當(dāng)然要是顏值再高一點(diǎn)那就更好了！
精準(zhǔn)簡(jiǎn)潔的 API 文檔可以推動(dòng)研發(fā)數(shù)據(jù)規(guī)范化，降低協(xié)作成本，從而大幅度提高團(tuán)隊(duì)效率！
最近總有阿里、騰訊、滴滴的開(kāi)發(fā)朋友提到 ApiPost，自己體驗(yàn)操作后，發(fā)現(xiàn)它的優(yōu)勢(shì)的確明顯：可以一鍵生成 API 文檔，完全中文，界面簡(jiǎn)潔美觀，而且免費(fèi)使用！很適合國(guó)內(nèi)的開(kāi)發(fā)者使用。聽(tīng)說(shuō)針對(duì)高校和培訓(xùn)機(jī)構(gòu)還是完全免費(fèi)的，無(wú)限工位，不限制任何功能。
怎么制作簡(jiǎn)潔精準(zhǔn)的 API 文檔？
要有層次有結(jié)構(gòu)
API 文檔絕不只是簡(jiǎn)單直白的列出各種參數(shù)，好的文檔應(yīng)該是有層次有結(jié)構(gòu)的內(nèi)容，可以讓使用者清晰理解。
精準(zhǔn)具象
API 本身就是抽象的，如果文檔也是抽象的，對(duì)于使用者來(lái)說(shuō)就是一場(chǎng)災(zāi)難了！可以多用實(shí)際案例，案例能顯著減少理解成本。
其次表達(dá)還要盡量精準(zhǔn)，避免模糊的表達(dá)。
界面友好可搜索
一個(gè)好的 API 文檔，它的界面交互也要簡(jiǎn)單易用，盡量提供好的使用體驗(yàn)。以往的文檔比較簡(jiǎn)單，現(xiàn)在的文檔多是基于網(wǎng)頁(yè)實(shí)現(xiàn)，可設(shè)計(jì)性很高，可以嘗試多種設(shè)計(jì)方式。
文檔如果內(nèi)容過(guò)多，在大量的代碼函數(shù)中尋找目標(biāo)會(huì)是一件非常費(fèi)時(shí)的事。為使用者提供搜索功能，可以減少搜索相關(guān)內(nèi)容的時(shí)間。
ApiPost 是什么？
ApiPost 是一個(gè)支持模擬 POST、GET、PUT 等常見(jiàn) HTTP 請(qǐng)求,支持團(tuán)隊(duì)協(xié)作,并可直接生成并導(dǎo)出接口文檔的 API 文檔、調(diào)試、Mock、測(cè)試一體化協(xié)作平臺(tái)。
簡(jiǎn)單說(shuō)：
ApiPost=Postman + Swagger + Mock + JMeter
接口開(kāi)發(fā)工作通常需要前端、后端、測(cè)試、技術(shù)經(jīng)理等多個(gè)崗位協(xié)作，但因?yàn)榱鞒涕L(zhǎng)所以難管理，不同工具之間數(shù)據(jù)也缺乏統(tǒng)一規(guī)范，導(dǎo)致團(tuán)隊(duì)效率往往會(huì)很低下！
ApiPost 通過(guò)整合工具以及團(tuán)隊(duì)協(xié)作功能，將 API 研發(fā)流程中的每個(gè)環(huán)節(jié)整合打通，大幅度提高整個(gè)研發(fā)團(tuán)隊(duì)的效率，解決了以上問(wèn)題。
ApiPost 的亮點(diǎn)
國(guó)內(nèi)外有一些很不錯(cuò)的開(kāi)源 API 文檔產(chǎn)品，比如 Swagger、Rap2 和 Yapi 等，每個(gè)產(chǎn)品支持的功能各有不同，可以說(shuō)各有特點(diǎn)。但因?yàn)槭情_(kāi)源的，對(duì)于企業(yè)用戶(hù)來(lái)說(shuō)會(huì)有一些問(wèn)題，比如國(guó)外產(chǎn)品是英文，有的產(chǎn)品的侵入性比較強(qiáng)，學(xué)習(xí)成本高，支持不及時(shí)等。
與這些開(kāi)源產(chǎn)品相比，ApiPost 的不同之處在于：
首先，ApiPost 是國(guó)內(nèi)團(tuán)隊(duì)開(kāi)發(fā)，全中文界面，對(duì)英文不好的朋友來(lái)說(shuō)，使用起來(lái)會(huì)非常舒服！
其次文檔信息豐富學(xué)習(xí)成本低，功能齊全，用戶(hù)在社區(qū)的提問(wèn)反饋及時(shí)！
在現(xiàn)在這樣的敏捷開(kāi)發(fā)年代，API 研發(fā)越來(lái)越注重整個(gè)項(xiàng)目的協(xié)作，比如 API 調(diào)試、API 文檔，如果能貫穿整個(gè)研發(fā)流程，與項(xiàng)目所有角色打通，團(tuán)隊(duì)效率和效果都將大大提高！ApiPost 就解決了這個(gè)問(wèn)題。
快速 API 調(diào)試
調(diào)試 API 的過(guò)程中有很多重復(fù)性的工作占據(jù)了大量的時(shí)間，比如一些參數(shù)（校驗(yàn)登陸的 token）可能每個(gè)接口都會(huì)用到。沒(méi)必要每個(gè)接口都設(shè)置一個(gè)這樣的參數(shù)，最好的方式是放到全局參數(shù)里。
ApiPost 的全局參數(shù)、全局腳本、cookie 管理、環(huán)境切換等功能可以減少大量重復(fù)性工作，讓 API 調(diào)試效率大大提升！
快速生成接口文檔
國(guó)內(nèi)對(duì)接口文檔是非常重視的，有文檔先行的理念，而國(guó)外對(duì)接口文檔就沒(méi)那么重視了。ApiPost 的生成文檔體驗(yàn)非常好，具體我們可以對(duì)比一下兩個(gè)產(chǎn)品的生成接口文檔的過(guò)程。
Postman 的生成接口文檔要點(diǎn)擊 publish，然后生成設(shè)置頁(yè)面，設(shè)置后才生成接口文檔。
ApiPost 不僅可以在接口頁(yè)面直接生成接口文檔鏈接，還可以顯示響應(yīng)事例，具體頁(yè)面如圖：
多人實(shí)時(shí)協(xié)作
傳統(tǒng)開(kāi)發(fā)場(chǎng)景是分離的，協(xié)作效率很低，而在 ApiPost 前后端開(kāi)發(fā)協(xié)作場(chǎng)景中，通過(guò)一份接口文檔，就可以實(shí)現(xiàn)前后端并行開(kāi)發(fā)：后臺(tái)開(kāi)發(fā)者把 API 托管在 API 網(wǎng)關(guān)上，使用 ApiPost 的 mock 功能模擬數(shù)據(jù)，利用 API 文檔功能把 API 信息提供給前端同學(xué)，來(lái)實(shí)現(xiàn)前后端分離。
ApiPost 有更本地化的協(xié)作功能，可以團(tuán)隊(duì)實(shí)時(shí)協(xié)作，團(tuán)隊(duì)成員新建接口同步在所有團(tuán)隊(duì)成員項(xiàng)目里。
比如鎖定接口，除鎖定者和管理員外，其他人均無(wú)法對(duì)其進(jìn)行編輯、修改操作。
還有很多協(xié)作方面的小功能，比如協(xié)作日志，歸檔管理、一鍵導(dǎo)入?yún)?shù)……
豐富的細(xì)節(jié)設(shè)計(jì)
我們獨(dú)創(chuàng)的參數(shù)描述庫(kù)功能，解決了大量重復(fù)填寫(xiě)參數(shù)描述的問(wèn)題！通常一個(gè)接口要調(diào)用多次，每次都要手動(dòng)錄入完全一致的描述，效率太低了！
在 ApiPost，你可以自定義參數(shù)描述庫(kù)，將項(xiàng)目用到的大量參數(shù)進(jìn)行預(yù)注釋?zhuān)麓握{(diào)用直接點(diǎn)選。如果你沒(méi)有自定義描述庫(kù)，第一次輸入描述后也會(huì)自動(dòng)加入描述庫(kù)。
類(lèi)似的細(xì)節(jié)還有很多，這些細(xì)節(jié)設(shè)計(jì)據(jù)說(shuō)都是產(chǎn)品在用戶(hù)的反饋中總結(jié)而來(lái)，可以說(shuō)正是這些細(xì)節(jié)讓 apipost 成為最懂用戶(hù)，最重視用戶(hù)的產(chǎn)品！
最后，建議開(kāi)發(fā)人員，包括后端、前端、測(cè)試朋友們都試試 ApiPost，尤其是后端開(kāi)發(fā)朋友來(lái)說(shuō)，這款工具太香了！
左下角“閱讀原文”進(jìn)入 ApiPost 官方下載通道：https://www.apipost.cn/download.html