對(duì)于中小型(特別是 Java 技術(shù)棧)的開發(fā)團(tuán)隊(duì)來(lái)說(shuō),Swagger 是一個(gè)便捷的選擇,好處是:
- 代碼即文檔,編寫成本低,不存在同步不及時(shí)的問(wèn)題;
- 生態(tài)好,各大 API 平臺(tái)都支持基于 OpenAPI 格式的拓展。
但使用 Swagger 的用戶有以下幾個(gè)痛點(diǎn):
- 測(cè)試不方便,有簡(jiǎn)單的調(diào)用測(cè)試,但是沒(méi)有歷史也沒(méi)有鑒權(quán)等功能;
- 沒(méi)有人員管理,無(wú)法協(xié)作/通知/版本管理;
- 對(duì)于前端人員不友好,沒(méi)有參數(shù)描述/值可能性,沒(méi)有 Mock ;
- 對(duì)代碼有侵入性。
我們不追求讓大家強(qiáng)制切換工具,而是作為代碼的下游 API 文檔工具,解決痛點(diǎn)的同時(shí)融合 Swagger 生態(tài)。Postcat 通過(guò)以下兩種方式支持代碼生成文檔:
- 如果你之前使用 Swagger,我們支持從 Swagger Url 自動(dòng)同步 Swagger 數(shù)據(jù);
- Jebrains IDE 插件,安裝后可以在 IDE 中右鍵一鍵同步代碼注釋中的 API 文檔信息到 Postcat。(下一篇內(nèi)容會(huì)講到)
下面即為大家演示如何如何支持 Swagger Url 自動(dòng)同步 Swagger 數(shù)據(jù)
從 Swagger URL 生成文檔
提示:要使用這個(gè)功能,一定得安裝 Swagger URL 插件才行
首先,找到對(duì)應(yīng)插件,并安裝

選擇通過(guò) URL 導(dǎo)入同步 API

填寫 Swagger URL 地址:

導(dǎo)入成功,右側(cè)展示了新增的 API

在 Postcat 上只要通過(guò)安裝這個(gè)導(dǎo)入插件,再也不用擔(dān)心 Swagger 的數(shù)據(jù)無(wú)法同步過(guò)來(lái)了。
了解 Postcat:
Postcat 是一個(gè)強(qiáng)大的開源、跨平臺(tái)(Windows、Mac、Linux、Browsers...)的 API 開發(fā)測(cè)試工具,支持 REST、Websocket 等協(xié)議(即將支持 GraphQL、gRPC、TCP、UDP),幫助你加速完成 API 開發(fā)和測(cè)試工作。
Postcat 核心功能:
- API 文檔管理:可視化 API 設(shè)計(jì),生成 API 文檔
- API 測(cè)試:自動(dòng)生成測(cè)試參數(shù),自動(dòng)生成測(cè)試用例,可視化數(shù)據(jù)編輯
- 插件拓展:眾多插件擴(kuò)展產(chǎn)品功能,打造屬于你和團(tuán)隊(duì)的 API 開發(fā)平臺(tái)
- Mock:根據(jù)文檔自動(dòng)生成Mock,或創(chuàng)建自定義 Mock 滿足復(fù)雜場(chǎng)景
- 團(tuán)隊(duì)協(xié)作:既能實(shí)現(xiàn)API 分享也能可以創(chuàng)建云空間共同協(xié)作
Postcat 優(yōu)勢(shì):
- 免登錄即可測(cè)試:省去繁瑣的驗(yàn)證登錄的操作
- 界面簡(jiǎn)潔:沒(méi)有冗余的功能與復(fù)雜選項(xiàng)
- 免費(fèi):中小團(tuán)隊(duì)以及個(gè)人使用
- 豐富的插件:支持?jǐn)?shù)據(jù)遷移、主題、API 安全等高達(dá)22款插件
- 國(guó)產(chǎn):能更好的理解國(guó)內(nèi)用戶的需求,與開發(fā)團(tuán)隊(duì)溝通無(wú)障礙
- 完善的用戶文檔:跟著操作就能快速上手
多提 Issue !多反饋!
在使用過(guò)程中有任何疑問(wèn),可以進(jìn)群交流:

也可以在線提 Issue(強(qiáng)烈推薦這種開源的方式),提問(wèn)題本身就已經(jīng)在貢獻(xiàn)社區(qū)了:
https://github.com/Postcatlab/postcat/issues

如果喜歡,不妨Star 支持一下
這個(gè)項(xiàng)目是開源的,如果你覺(jué)得這個(gè)項(xiàng)目還不錯(cuò)的話,不妨點(diǎn)個(gè) Star 支持一下!
Github :https://github.com/Postcatlab/postcat
Gitee :https://gitee.com/eolink_admin/postcat
更多建議: