让你直呼哇塞的API管理神器!
作為開發者,包括前端、后端、測試人員最離不開的一個工具就是Postman,方便我們用來做API接口進行調試。但 Postman并不完全符合我們對API的各種需求,比如維護API文檔、API Mock、API自動化測試等等。最近發現一款API一站式服務的工具:Apifox,毫不夸張的說吊打Postman!
1.關于Apifox
Apifox 是 API 文檔、API 調試、API Mock、API 自動化測試一體化協作平臺,定位 Postman + Swagger + Mock + JMeter。一站式服務解決多個系統之間的數據同步問題。
2. 如何安裝
首先,我們打開Apifox官網:https://www.apifox.cn/,根據我們系統選擇要下載的版本,這里以Macos版本為例子
官網界面首先我們需要創建一個團隊,Apifox支持團隊管理,你可以把自己團隊的小伙伴邀請加入進來。而且支持云端數據共享!方便團隊成員間協作
創建團隊🔧然后我們在該團隊中創建項目,Apifox的項目進行權限管理(比如管理員設置、只讀權限等等)
創建項目📚創建項目成功,我們開始進行體驗Apifox強大的功能!
Apifox很體貼,提供了一個寵物商店完整CRUD的API Demo給用戶使用,方便新用戶第一時間可以通過Demo嘗鮮!如下圖👇
Demo 嘗鮮3.支持API文檔導入
Apifox支持導入Swagger、Postman、RAP2、JMeter、YApi、Eolinker、Apizza、ShowDoc、apiDoc等多達20種工具的導入。看得出市場上大部分數據類型Apifox都兼容了,我們再也不用擔心數據遷移的問題了!
接下來聊聊如何通過Apifox導入接口文檔
通過點擊下圖所示的導入按鈕 👇
導入接口文檔📒然后在導入界面中的數據格式選項中選擇Swagger,并選中URL導入Tab按鈕,最后輸入Swagger的數據Url即可 👇
導入接口文檔📒成功導入后,將會顯示導入預覽面板,顯示內容包括:要導入的接口、數據模型等,Apifox將會把我們接口返回的實體類轉換為數據模型,方便下次復用
生成接口數據當完成以上步驟后就可以開始調試接口了。下圖中我們可以發現APifox對查看文檔和修改文檔分成兩個Tab模塊,方便我們管理接口文檔。
4.接口管理
玩轉上面的流程后,我們開始核心基礎功能的體驗。比如單個接口的編輯與調試
4.1 接口設計
接口離不開接口請求參數,以及各個參數的說明。而這方面Apifox界面中的參數說明很詳細!
請求參數界面講完請求參數,我們看下返回結果界面,結果呈現樹狀結構,重點是支持折疊。國內大多同類型軟件都是沒有的!
返回結果界面最后我們看下另外一個Tab功能模塊修改文檔,支持狀態修改、分組和標簽功能
4.2 接口調試
說到接口調試,我相信你一定會第一想到postman,但是你可能還不知道我們國人做的Apifox功能比Postman更強大
Apifox支持環境配置,默認給我們設定了三種環境:正式環境、測試環境、Mock服務。方便我們在開發接口時,針對不同環境的場景可以做相應的配置
多種環境支持當你開始調試接口之前,我們需要先配置好環境所定義的 前置Url, 這里以正式環境為例
設置前置Url同時Apifox支持在接口調用前、接口調用返回后,做一些自定義操作。在Apifox界面中分別稱為前置操作和后置操作。以后置操作作為例子
前置操作 & 后置操作我們在其中一個接口的后置操作中添加一個斷言,假若接口返回 code=200, 則表示操作成功
支持斷言最后我們調用該接口,來驗證下這個功能!發現斷言結果跟我們預期不一致!
5.自定義腳本
前文我們介紹了Apifox強大的前置操作、后置操作功能,支持自定義,不僅僅支持簡單的斷言和提取變量,還能自定義腳本(自己編寫JS文件)
支持自定義腳本 ??同樣,我們用上述的自定義腳本來校驗我們的接口返回數據
6.前端 Mock 數據
Mock數據也是Apifox強大的功能之一,號稱零配置即可生成非常人性化的mock數據。
那我們來看看Apifox都內置了哪些智能規則 👇
預設Mock規則其中有一個特別有愛的規則是@image,我們根據選擇不同尺寸mock出不同的圖片 如下圖配置👇
Mock 圖片 🖼?當你覺得Apifox內置的Mock功能不夠滿足你的應用場景,我們又可以自定義了,支持前端熟悉的Mock.js 語法編寫mock規則 👇
支持Mockjs拓展 🔧當你完成mock規則配置之后,只需將環境切換到Mock服務就可以開始調用Mock數據接口了!
接下來我們來看下通過Apifox Mock的數據是不是正如官網所說的人性化? 👇
人性化的Mock數據 🤩哇!無論是圖片、ID還是數組對象中的數值,都按照我期望的格式返回了Mock數據。
如果官方默認預設的Mock規則,還無法滿足你的場景,你再結合上文提到的通過Mockjs來自定義規則就可以了
7.彩蛋
Apifox除了擁有強大的功能之外,最吸引我的地方還有交互與設計。甚至還支持主題選擇,我個人偏向使用官方默認的背景“暗色”及主色“湖藍”的搭配
最后
Apifox除了具備強大的功能之外,UI界面交互設計也是國內同類型軟件無法媲美的。Postman有的接口調試功能它基本都有,還集成了Mock數據、API文檔管理、自動化測試等等功能。而且擴展性也很好,比如自定義腳本、前置操作、后置操作等等。相信你體驗完,你一定直呼哇塞!🤩
推薦閱讀
牛逼!Python常用數據類型的基本操作(長文系列第①篇)
牛逼!Python的判斷、循環和各種表達式(長文系列第②篇)
牛逼!Python函數和文件操作(長文系列第③篇)
牛逼!Python錯誤、異常和模塊(長文系列第④篇)
總結
以上是生活随笔為你收集整理的让你直呼哇塞的API管理神器!的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: “阿里味” PUA 编程语言火上GitH
- 下一篇: 开源的恶果,程序员正在「自掘坟墓」