一、安裝
ApiFox提供了免費的SAAS版本和收費的本地部署版本。我們可以選擇SAAS版本來使用,SAAS版本提供了客戶端和WEB版本皆可使用。
官網地址:https://www.apifox.cn/,可以在官網下載客戶端,也可以直接訪問WEB版本。
官方指導文檔:https://www.apifox.cn/help/
二、注冊
自行注冊之后,就可以登錄使用了。
三、添加成員進入項目
ApiFox是支持團隊協作的。可以通過如下步驟來添加到團隊,這樣成員就可以訪問你的項目了,可以做共同的管理:
選擇項目,選擇成員/權限,點擊邀請成員
需要根據注冊的人員的賬號名或者郵箱來進行查找
可以給新加的成員賦予相應的權限
四、第一個接口文檔
-
新增一個團隊
-
新增一個項目
-
點擊這個項目,就可以進入項目
-
進入項目
-
新建一個分組
-
新建第一個接口文檔
-
輸入相應的值,保存即可
返回值可以自己寫,也可以用json方式導入,會自動生成返回的樣式
點擊保存,這樣一個接口的文檔就完成啦,當你完成的時候你的團隊成員都能看到
五、 接口文檔執行,生成用例
-
配置環境,我這邊本地啟動了一個服務使用5016端口,所以我配置的是http://127.0.0.1:5016
-
點擊發送
-
這樣我們就完成了這個接口的請求,只要接口文檔寫的正確,就可以完全復用接口文檔來進行接口的請求(當然我們也可以去更改示數據來進行測試,此處就不作過多贅述了)
六、mock接口數據
如下圖:我們可以點擊快捷調試
可以看到會按照我們定義的接口格式返回數據(不過目前暫時不支持自定義數據)
測試下,用瀏覽器訪問下,完美訪問。(在本地啟動了服務,接口默認4523)可以支持前端同學需要數據調試
關於mock地址、端口信息,到目前(2022年3月)不支持修改
七、測試使用過程中的一些小技巧
-
設置變量,我們可以在環境管理中去添加一些環境變量
-
也可以在全局變量中去定義一些變量,比如我們定義了一個全局變量叫jsid,用來存儲我們的登陸身份
那我們在接口請求中可以使用{{jsid}}(即使用{{變量名}}的方式來引用),當使用如此方式的時候,變量名從{{變量名}} 變成變色的 變量名,如下圖所示