apifox是款接口調(diào)試軟件，其中將支持多種不同的調(diào)試數(shù)據(jù)結(jié)構(gòu)，功能相當?shù)膹姶?，以便開發(fā)人員更加便捷的進行開發(fā)測試，以便達到提高效率的作用，相當適合前端用戶人員。

apifox使用教程

1、使用場景

后端開發(fā)

接口文檔管理

后端代碼自動生成

接口調(diào)試

接口自測

前端開發(fā)

接口文檔管理

接口數(shù)據(jù) Mock

接口調(diào)試

前端代碼自動生成

測試人員

接口調(diào)試

接口測試

性能測試

2、基本功能

1）團隊協(xié)作

接口數(shù)據(jù)云端同步，實時更新；支持團隊/項目管理員、普通成員、只讀成員等權(quán)限管理

安裝后，登錄自己的賬號，由團隊成員邀請加入，通過后，即可共享團隊所有項目的接口數(shù)據(jù)

 2）導入導出

導入接口文檔

以YApi舉例

從yapi平臺，選擇服務(wù)-數(shù)據(jù)管理，導出json格式的文件

apifox - 接口管理 - 導入，選擇數(shù)據(jù)格式為YApi，導入json文件

導入成功后，點擊接口管理，即可看到導入的接口數(shù)據(jù) 

導入抓包數(shù)據(jù)

3）接口&用例

定義接口的請求信息、基礎(chǔ)狀態(tài)信息、response示例信息

通過前置、后置操作，對數(shù)據(jù)進行處理和斷言；

自動校驗接口中定義的response數(shù)據(jù)結(jié)構(gòu)，也可自定義response校驗點

測試用例集

測試用例主要用來做接口集合測試，每個用例包含多個測試步驟，每個步驟都是一個接口請求

查看測試報告

可以查看歷史的執(zhí)行記錄，目前測試報告數(shù)據(jù)僅存放在本地電腦

基本的性能測試

執(zhí)行用例時，可設(shè)置循環(huán)次數(shù)、線程數(shù)，可導入批量的測試數(shù)據(jù)

4）快速mock

根據(jù)接口定義的數(shù)據(jù)結(jié)構(gòu)自動生成測試數(shù)據(jù)，無需配置mock規(guī)則，方便前端調(diào)試

5）變量的管理及使用

公共數(shù)據(jù)可配置遠程值：“遠程值”會同步保存到服務(wù)器，僅用于成員之間相互同步，實際運行時都是讀寫“本地值”

自己的測試數(shù)據(jù)可配置本地值：“本地值”僅保存在本地，不會同步到服務(wù)器，團隊成員之間也不會相互同步

外部使用變量：{{變量名}

腳本中獲取/設(shè)置變量：通過get/set

6）數(shù)據(jù)庫連接

項目設(shè)置 - 數(shù)據(jù)庫連接，可管理連接的數(shù)據(jù)庫

數(shù)據(jù)庫連接信息僅存儲在本地，不會同步到云端，所以使用時，需自己手動設(shè)置

7）自定義腳本

apifox支持多種語言腳本：java、python、PHP、js等

舉個栗子

自定義python腳本，獲取外部的傳參

在指定目錄下，放入自己的腳本

apifox調(diào)用腳本、傳參

常見問題

1. Apifox 是否收費？

Apifox 公網(wǎng)版 (SaaS版) 免費，私有化部署版收費。

2. 登錄（Auth）態(tài)如何實現(xiàn)？

請參考文檔：登錄態(tài)（Auth）如何處理

3. 接口發(fā)送請求前需要調(diào)用登錄接口獲取 token 放在 header，如何實現(xiàn)？

請參考文檔：登錄態(tài)（Auth）如何處理

4. B 接口請求參數(shù)依賴于 A 接口返回的數(shù)據(jù)，如何實現(xiàn)？

請參考文檔：接口之間如何傳遞數(shù)據(jù)

5. 同項目下有不同域名的接口，如何處理？

方案一：在環(huán)境里新增多個服務(wù)，分別設(shè)置不同的前置 URL ,接口分組和接口維度可以指定對應(yīng)的前置 URL。推薦本方案！

方案二：把域名設(shè)置成環(huán)境變量如DOMAIN_1，接口路徑這樣填寫：https:///users。接口路徑是以http://或https://起始的，系統(tǒng)會自動忽略里環(huán)境里前置 URL。

方案三：給不同域名接口設(shè)置不同環(huán)境，通過切換環(huán)境來運行不同域名下的接口。不推薦本方案！

6. 腳本如何讀取或修改接口請求信息？

請參考文檔： 腳本讀取/修改接口請求信息

7. 是否支持查詢數(shù)據(jù)庫字段作為參數(shù)傳給接口？

支持，請參考文檔：數(shù)據(jù)庫操作

8. 數(shù)據(jù)是存儲在本地還是云端？可否離線使用？可否私有化部署？

目前 Apifox 有 Saas 版 和私有化部署版 。

Saas 版 是免費的，數(shù)據(jù)都是存在云端的，需要聯(lián)網(wǎng)才能使用。

私有化部署版 是收費的，數(shù)據(jù)存在使用者企業(yè)內(nèi)部，不連外網(wǎng)也可以使用。

注意

環(huán)境變量/全局變量里的 本地值 僅存放在本地，不會同步到云端，團隊成員之間也不會相互同步，適合存放token、賬號、密碼之類的敏感數(shù)據(jù)。

9. 使用 Postman 調(diào)用接口返回正常，而 Apifox 返回錯誤

解決方法：對比 postman 和 apifox 實際發(fā)出的請求內(nèi)容（url、參數(shù)、body、header）是否完全一樣。

查看實際請求內(nèi)容方法：

Apifox：返回內(nèi)容下的實際請求 tab (老版本為Request tab) 里查看

Postman：點擊底部狀態(tài)欄里的Console查看

10. 為什么修改了環(huán)境變量（或全局變量）值，而引用的地方?jīng)]有生效？

請檢查環(huán)境變量、全局變量、臨時變量里是不是有多個地方定義了相同名稱的變量，如果有，系統(tǒng)會根據(jù)優(yōu)先級來取值。優(yōu)先級順序如下：臨時變量>環(huán)境變量>全局變量。

請檢查修改的是否是本地值，環(huán)境變量（或全局變量）僅讀取本地值，而不會讀取遠程值。

軟件功能

高效團隊協(xié)作

接口云端同步，實時更新。成熟的團隊/項目權(quán)限管理，滿足各類企業(yè)的需求。

可視化接口管理

方便快捷可視化接口管理，成倍提升團隊多人協(xié)作效率。

支持數(shù)據(jù)結(jié)構(gòu)(JSON Schema)管理，多接口可復用相同數(shù)據(jù)結(jié)構(gòu)。

自動化測試

完善的接口自動化測試功能，保證接口數(shù)據(jù)的正確性。

支持自定義腳本，自動化檢查數(shù)據(jù)正確性。自定義腳本語法 100% 兼容 Postman，降低學習成本。

自動校驗數(shù)據(jù)結(jié)構(gòu)

接口調(diào)試時，自動校驗返回的數(shù)據(jù)結(jié)構(gòu)是否符合接口文檔定義，一鍵發(fā)現(xiàn)接口數(shù)據(jù)異常。

接口數(shù)據(jù) Mock

內(nèi)置 Mock.js 規(guī)則引擎，非常方便 mock 出各種數(shù)據(jù)，并且可以在定義數(shù)據(jù)結(jié)構(gòu)的同時寫好 mock 規(guī)則。

支持自定義期望，靈活配置根據(jù)參數(shù)值返回不同數(shù)據(jù)內(nèi)容。

零配置即可 Mock 出非常人性化的數(shù)據(jù)

數(shù)據(jù)導入/導出

支持導出 OpenApi (原Swagger)、Markdown、Html 等數(shù)據(jù)格式。

支持導入 OpenApi格式(原Swagger)、Postman、HAR、RAP2、yapi、Eolinker、DOClever、ApiPost、Apizza 等數(shù)據(jù)格式。

接口調(diào)試

Postman 有的功能，比如環(huán)境變量、預執(zhí)行腳本、后執(zhí)行腳本、Cookie/Session 全局共享 等功能，Apifox 都有，并且和 Postman 一樣高效好用。

更新日志

v1.4.21

2022-01-18

【優(yōu)化】openapi 導入，示例字段 example 的優(yōu)化。

解決多前置 URL 偶現(xiàn)失效的情況。

新建 tab 頁打開多個情況下，關(guān)閉最初的一個后再次點擊新建沒有打開的問題。

v1.4.20

2022-01-14

解決生成代碼生成偶現(xiàn)失敗的情況。