程序員最討厭的兩件事：
- 寫文檔
- 別人不寫文檔
寫文檔敞恋、維護(hù)文檔比較麻煩丽啡，而且費(fèi)時(shí)，還會經(jīng)常出現(xiàn) API 更新了硬猫，但文檔還是舊的补箍，各種同步不一致的情況，從而耽擱彼此的時(shí)間啸蜜，大多數(shù)開發(fā)人員不愿意寫 API 文檔坑雅。
Eolink Apikit 為后端工程師提供 API 文檔的創(chuàng)建與自動化生成、快速接口調(diào)試衬横、以及 API 文檔版本管理功能霞丧，協(xié)助后端工程師快速編寫文檔，調(diào)試接口冕香，以及支持版本控制恢復(fù)歷史記錄坛善。
通過一套系統(tǒng)鹅士、一份數(shù)據(jù)，解決多個(gè)系統(tǒng)之間的數(shù)據(jù)同步問題。只要定義好接口文檔脆丁，接口調(diào)試惨缆、數(shù)據(jù) Mock寥裂、接口測試就可以直接使用哈垢，無需再次定義。接口文檔和接口開發(fā)調(diào)試使用同一個(gè)工具惫霸，接口調(diào)試完成后即可保證和接口文檔定義完全一致猫缭。高效、及時(shí)壹店、準(zhǔn)確猜丹！
1、創(chuàng)建 API 文檔
- 點(diǎn)擊“+ 添加API”按鈕后硅卢，系統(tǒng)會新開一個(gè)新建API的標(biāo)簽射窒。
- 在新頁面中填寫API文檔的信息藏杖，居然可輸入信息如下。
- 點(diǎn)擊左上角的保存按鈕即可創(chuàng)建新的API文檔脉顿。
2蝌麸、自動化生成 API 文檔
該功能可通過配置數(shù)據(jù)源信息，實(shí)現(xiàn)基于數(shù)據(jù)源的API信息自動生成API文檔艾疟。當(dāng)前支持5種數(shù)據(jù)源：Swagger URL来吩、apiDoc、Github蔽莱、gitlab弟疆、碼云。
- 點(diǎn)擊“+ 添加來源”后碾褂，系統(tǒng)彈窗中可選擇5種數(shù)據(jù)源，可選擇其中一種历葛。（此處以推薦的“通過 Swagger URL”來舉例）
- 選中來源類型后正塌，根據(jù)提醒填入來源名稱和對應(yīng)的swagger.json訪問地址即可。注意該訪問地址需要允許外網(wǎng)訪問方可使用恤溶。
3乓诽、快速接口調(diào)試
1. 已有 API 文檔快速測試
如果該接口已經(jīng)在Apikit上創(chuàng)建了文檔，則可以直接在文檔內(nèi)選擇測試子TAB咒程，進(jìn)行快速測試鸠天。
2. 未有文檔臨時(shí)測試
如果未創(chuàng)建該接口文檔，僅臨時(shí)調(diào)試接口帐姻，則可創(chuàng)建API快速測試頁面稠集。可在這個(gè)頁面輸入接口相關(guān)的信息并進(jìn)行快速測試饥瓷。
若測試沒問題剥纷，可點(diǎn)擊右上角的“保存為新API”，快速把測試數(shù)據(jù)保存為API文檔呢铆，方便下次調(diào)試晦鞋。
4、API 文檔版本管理
API文檔的版本管理有兩類棺克，單API文檔的編輯歷史記錄悠垛，以及項(xiàng)目級API文檔的版本管理。
1. API 文檔歷史記錄
點(diǎn)擊API文檔詳情頁右側(cè)工具欄中的“歷史記錄”圖標(biāo)按鈕娜谊，即可查看該文檔的所有歷史編輯記錄确买。
在歷史記錄列表中，可對該文檔過往的歷史記錄進(jìn)行對比纱皆、查看備注拇惋、以及恢復(fù)該歷史記錄的內(nèi)容周偎。
2. 項(xiàng)目級版本管理
Eolink Apikit 提供項(xiàng)目級的版本管理功能，可以對項(xiàng)目進(jìn)行打版本撑帖，保存一份當(dāng)前項(xiàng)目所有API文檔的快照蓉坎。以便進(jìn)行版本對比和分支版本管理。
點(diǎn)擊“+ 添加版本”按鈕胡嘿，并輸入版本號后點(diǎn)擊確認(rèn)蛉艾，系統(tǒng)會對當(dāng)前項(xiàng)目創(chuàng)建新的版本快照。
可隨時(shí)查看某個(gè)版本的所有API文檔信息衷敌，并可對多個(gè)版本進(jìn)行版本對比勿侯。
支持把某個(gè)版本直接復(fù)制成新項(xiàng)目進(jìn)行分支版本管理，或把歷史版本數(shù)據(jù)進(jìn)行全局導(dǎo)出缴罗。
無論使用什么語言開發(fā)助琐，Eolink Apikit 都可以統(tǒng)一規(guī)范地管理起來，并提供強(qiáng)大的文檔管理面氓、協(xié)作兵钮、測試、分享功能舌界。
- 自動生成 API 文檔掘譬，并支持動態(tài)更新；
- 首創(chuàng)的版本管理呻拌、差異對比葱轩、變更通知；
- 強(qiáng)大的自定義請求校驗(yàn)與響應(yīng)藐握，便于前后端對接和集成測試等場景靴拱；
- 在線分享 & 導(dǎo)出，版本管理與評論猾普，方便開發(fā)協(xié)缭嫡；
- 支持多層級項(xiàng)目權(quán)限管理，支持自定義角色與權(quán)限抬闷。
