對于中小型(特別是 Java 技術(shù)棧)的開發(fā)團(tuán)隊來說,Swagger 是一個便捷的選擇,好處是:
- 代碼即文檔,編寫成本低,不存在同步不及時的問題;
- 生態(tài)好,各大 API 平臺都支持基于 OpenAPI 格式的拓展。
但使用 Swagger 的用戶有以下幾個痛點(diǎn):
- 測試不方便,有簡單的調(diào)用測試,但是沒有歷史也沒有鑒權(quán)等功能;
- 沒有人員管理,無法協(xié)作/通知/版本管理;
- 對于前端人員不友好,沒有參數(shù)描述/值可能性,沒有 Mock ;
- 對代碼有侵入性。
我們不追求讓大家強(qiáng)制切換工具,而是作為代碼的下游 API 文檔工具,解決痛點(diǎn)的同時融合 Swagger 生態(tài)。Postcat 通過以下兩種方式支持代碼生成文檔:
- 如果你之前使用 Swagger,我們支持從 Swagger Url 自動同步 Swagger 數(shù)據(jù);
- Jebrains IDE 插件,安裝后可以在 IDE 中右鍵一鍵同步代碼注釋中的 API 文檔信息到 Postcat。(下一篇內(nèi)容會講到)
下面即為大家演示如何如何支持 Swagger Url 自動同步 Swagger 數(shù)據(jù)
從 Swagger URL 生成文檔
提示:要使用這個功能,一定得安裝 Swagger URL 插件才行
首先,找到對應(yīng)插件,并安裝
選擇通過 URL 導(dǎo)入同步 API
填寫 Swagger URL 地址:
導(dǎo)入成功,右側(cè)展示了新增的 API
在 Postcat 上只要通過安裝這個導(dǎo)入插件,再也不用擔(dān)心 Swagger 的數(shù)據(jù)無法同步過來了。
了解 Postcat:
Postcat 是一個強(qiáng)大的開源、跨平臺(Windows、Mac、Linux、Browsers...)的 API 開發(fā)測試工具,支持 REST、Websocket 等協(xié)議(即將支持 GraphQL、gRPC、TCP、UDP),幫助你加速完成 API 開發(fā)和測試工作。
Postcat 核心功能:
- API 文檔管理:可視化 API 設(shè)計,生成 API 文檔
- API 測試:自動生成測試參數(shù),自動生成測試用例,可視化數(shù)據(jù)編輯
- 插件拓展:眾多插件擴(kuò)展產(chǎn)品功能,打造屬于你和團(tuán)隊的 API 開發(fā)平臺
- Mock:根據(jù)文檔自動生成Mock,或創(chuàng)建自定義 Mock 滿足復(fù)雜場景
- 團(tuán)隊協(xié)作:既能實(shí)現(xiàn)API 分享也能可以創(chuàng)建云空間共同協(xié)作
Postcat 優(yōu)勢:
- 免登錄即可測試:省去繁瑣的驗(yàn)證登錄的操作
- 界面簡潔:沒有冗余的功能與復(fù)雜選項
- 免費(fèi):中小團(tuán)隊以及個人使用
- 豐富的插件:支持?jǐn)?shù)據(jù)遷移、主題、API 安全等高達(dá)22款插件
- 國產(chǎn):能更好的理解國內(nèi)用戶的需求,與開發(fā)團(tuán)隊溝通無障礙
- 完善的用戶文檔:跟著操作就能快速上手
多提 Issue !多反饋!
在使用過程中有任何疑問,可以進(jìn)群交流:
也可以在線提 Issue(強(qiáng)烈推薦這種開源的方式),提問題本身就已經(jīng)在貢獻(xiàn)社區(qū)了:
https://github.com/Postcatlab/postcat/issues
如果喜歡,不妨Star 支持一下
這個項目是開源的,如果你覺得這個項目還不錯的話,不妨點(diǎn)個 Star 支持一下!
Github :https://github.com/Postcatlab/postcat
Gitee :https://gitee.com/eolink_admin/postcat
更多建議: