在這個軟件開發(fā)日益復(fù)雜的時代，API 調(diào)試和文檔編寫的需求越來越強烈，而 Apifox 正是應(yīng)運而生，成為開發(fā)者們的秘密武器。作為一款全能的 API 工具，Apifox 不僅僅是一個 API 調(diào)試工具，更是集合了接口文檔生成、接口 Mock、接口管理、團隊協(xié)作等多種功能的綜合性工具。它的出現(xiàn)，打破了傳統(tǒng)開發(fā)流程中的效率瓶頸，幫助開發(fā)者和團隊更高效地進行 API 測試和協(xié)作。

Apifox更新日志

v2.6.30版本

新功能：發(fā)布文檔 時可以發(fā)布多個站點，每個站點可以選擇部分接口發(fā)布

解決使用腳本操作全局 Cookie 時，界面會一直顯示加載中的問題

解決導(dǎo)出定時運行的自動化測試的測試報告時，未包含詳情的問題

解決導(dǎo)入 Swagger/OpenAPI 格式的數(shù)據(jù)時，沒有正確導(dǎo)入 Apifox 擴展的 x-apifox-maintainer 責(zé)任人字段的問題

v2.6.8版本

【新功能】調(diào)試接口、用例時，切換文檔定義的 返回響應(yīng) 后，會立即重新 校驗響應(yīng)，無需重新發(fā)送請求

【優(yōu)化】在 組織 的團隊管理頁面，可以將個人團隊 移動 到組織內(nèi)

【優(yōu)化】在 組織 的成員管理頁面，可以通過鏈接或郵箱 邀請 別人加入組織

【優(yōu)化】在團隊的訂單管理頁面，可以查看 定時任務(wù) 的用量

【優(yōu)化】定時導(dǎo)入 接口數(shù)據(jù)，支持立即運行通過自托管 Runner 執(zhí)行的導(dǎo)入任務(wù)

【優(yōu)化】定時導(dǎo)入 接口數(shù)據(jù)，導(dǎo)入頻率最短可以配置為每隔 5 分鐘

【優(yōu)化】導(dǎo)入 Swagger/OpenAPI 文件時，可以配置當(dāng) summary 為空時，優(yōu)先使用 operationId、path 作為接口名，還是優(yōu)先從 descrption 中提取接口名

【優(yōu)化】當(dāng)引用的 測試場景 被 Fork 到子分支時，會使用子分支的資源來運行

【優(yōu)化】Markdown 文檔的大綱內(nèi)的英文單詞，不再會被截斷

解決點擊測試報告列表頁的“去看看”鏈接時，某些情況下沒有打開測試報告的問題

解決配置項目成員的自定義權(quán)限時，沒有正確展示成員昵稱的問題

Apifox注意事項

維護不同工具之間數(shù)據(jù)一致性非常困難、非常低效。并且這里不僅僅是工作量的問題，更大的問題是多個系統(tǒng)之間數(shù)據(jù)不一致，導(dǎo)致協(xié)作低效，頻繁出問題，開發(fā)人員痛苦不堪。

開發(fā)人員在 Swagger 定義好文檔后，接口調(diào)試的時候還需要去 Postman 再定義一遍。

前端開發(fā) Mock 數(shù)據(jù)的時候又要去 RAP 定義一遍，手動設(shè)置好 Mock 規(guī)則。

測試人員需要去 JMeter 定義一遍。

前端根據(jù) RAP Mock 出來的數(shù)據(jù)開發(fā)完，后端根據(jù) Swagger 定義的接口文檔開發(fā)完，各自測試測試通過了，本以為可以馬上上線，結(jié)果一對接發(fā)現(xiàn)各種問題：原來開發(fā)過程中接口變更，只修改了 Swagger，但是沒有及時同步修改 RAP。

同樣，測試在 JMeter 寫好的測試用例，真正運行的時候也會發(fā)現(xiàn)各種不一致。

時間久了，各種不一致會越來越嚴(yán)重。

Apifox免費版導(dǎo)入數(shù)據(jù)方法

打開項目設(shè)置面板，點擊導(dǎo)入/導(dǎo)出即可使用導(dǎo)入數(shù)據(jù)功能。

一、導(dǎo)入 OpenAPI (Swagger) 數(shù)據(jù)

支持導(dǎo)入 OpenAPI 3、Swagger 1、2、3數(shù)據(jù)格式的json或yaml文件。

注意：

需要URL導(dǎo)入的時候，需要填寫的是json或yaml數(shù)據(jù)文件的 URL，而不是Swagger UI的 URL。

二、導(dǎo)入 Postman 數(shù)據(jù)

支持 Postman Collection v2.1 格式。

數(shù)據(jù)導(dǎo)出方法：找到 Postman 左側(cè)列表 Collections，鼠標(biāo)移到需要導(dǎo)出的集合，點擊···，選擇Export然后選擇Collection v2.1 (recommended)即可導(dǎo)出，如下圖所示：

三、導(dǎo)入 ShowDoc 格式數(shù)據(jù)

將從 ShowDoc 導(dǎo)出的Markdown 壓縮包解壓，會看到一個文件名為prefix_info.json的 json 文件。

導(dǎo)入 Apifox 的時候，選擇ShowDoc格式，然后導(dǎo)入前面解壓得到的prefix_info.json文件即可。

四、導(dǎo)入 Eolinker 數(shù)據(jù)

支持Eolinker 項目數(shù)據(jù) (.json)格式。

Eolinker 數(shù)據(jù)導(dǎo)出方法：打開 Eolinker 里對應(yīng)項目，點擊左側(cè)菜單項目設(shè)置，在項目 Tab 里點擊導(dǎo)出項目，選擇Eolinker 項目數(shù)據(jù) (.json)，然后導(dǎo)出，如下圖所示：

五、導(dǎo)入 ApiPost 數(shù)據(jù)

支持 ApiPost HTML 格式數(shù)據(jù)格式.

數(shù)據(jù)導(dǎo)出方法：打開 ApiPost，點擊左側(cè)導(dǎo)航項目，選擇對應(yīng)項目，點擊右側(cè)分享項目文檔，在瀏覽器打開分享鏈接，在打開的網(wǎng)頁里，找到右上角離線導(dǎo)出，選擇導(dǎo)出HTML，然后導(dǎo)出，如下圖所示：

六、導(dǎo)入 DOCWAY 數(shù)據(jù)

支持 DOCWAY 復(fù)制分享地址的方式導(dǎo)入數(shù)據(jù)。

使用方法：打開 DOCWAY，進入對應(yīng)項目，鼠標(biāo)移到左上角更多功能點擊分享項目(注意僅項目創(chuàng)建者有權(quán)限分享項目)，創(chuàng)建分享 (注意“閱讀密碼”必須設(shè)置為空)，然后復(fù)制分享地址將地址黏貼到下面輸入框。如下圖所示：

Apifox軟件快捷鍵

新建快捷調(diào)試：Ctrl + T

新建接口：Ctrl + N

保存接口 / 保存用例：Ctrl + S

發(fā)送請求：Ctrl + Enter

切換到【運行】Tab：Ctrl + Enter

強制關(guān)閉 Tab：Ctrl + Alt + W

關(guān)閉 Tab：Ctrl + W

導(dǎo)入抓包數(shù)據(jù) (cURL)：Ctrl + I

導(dǎo)入數(shù)據(jù)：Ctrl + O

查找接口：Ctrl + F

切換到上一個 Tab：Ctrl + Shift + Tab 或 Ctrl + PageUp

切換到下一個 Tab：Ctrl + Tab 或 Ctrl + PageDown

跳轉(zhuǎn)到特定標(biāo)簽頁：Ctrl + 1 到 Ctrl + 8

跳轉(zhuǎn)到最后一個標(biāo)簽頁：Ctrl + 9

???????

Apifox軟件功能

一、一站式接口協(xié)作平臺

Apifox = Postman + Swagger + Mock + JMeter

一套系統(tǒng)、一份數(shù)據(jù)，解決多個 API 工具之間的數(shù)據(jù)同步問題

只要定義好 API 文檔，API 調(diào)試、API Mock、API 自動化測試即可直接使用，無需再次定義。

API 文檔和 API 開發(fā)調(diào)試使用同一個工具，API 調(diào)試完成后即可保證和 API 文檔定義完全一致。

二、接口設(shè)計所見即所得

Apifox 接口文檔遵循 OpenAPI 3.0 (原 Swagger)、JSON Schema 規(guī)范的同時，提供了非常好用的可視化文檔管理功能，零學(xué)習(xí)成本，非常高效。并且支持在線分享接口文檔。同一個接口通常會有多種情況，比如正確用例、參數(shù)錯誤用例、數(shù)據(jù)為空用例、不同數(shù)據(jù)狀態(tài)用例。設(shè)計接口時支持定義各個接口的狀態(tài)。

三、一次請求，重復(fù)調(diào)用

無需提前定義接口即可快速調(diào)試。支持設(shè)置環(huán)境變量、前置/后置腳本、Cookie/Session 全局共享等功能。接口運行調(diào)試完成后支持一鍵保存，后續(xù)無需輸入?yún)?shù)即可重復(fù)運行接口用例，十分便利。

四、自動生成代碼

根據(jù)接口模型定義，自動生成各種語言/框架(如 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等)的業(yè)務(wù)代碼(如 Model、Controller、單元測試代碼等)和接口請求代碼。目前 Apifox 支持 130 種語言及框架的代碼自動生成。

更重要的是：你可以通過自定義代碼模板來生成符合自己團隊的架構(gòu)規(guī)范的代碼，滿足各種個性化的需求。

自定義腳本支持運行 javascript、java、python、php、js、BeanShell、go、shell、ruby、lua 等各種語言代碼。

五、智能化接口管理

使用 Apifox 調(diào)試接口的時候，系統(tǒng)會根據(jù)接口文檔里的定義，自動校驗返回的數(shù)據(jù)結(jié)構(gòu)是否正確。不再需要通過肉眼識別，也無需手動寫斷言腳本檢測。運行接口用例時會自動校驗數(shù)據(jù)正確性，提升調(diào)試效率。根據(jù)接口及數(shù)據(jù)數(shù)據(jù)模型定義，系統(tǒng)還能夠自動生成接口請求代碼、前端業(yè)務(wù)代碼及后端業(yè)務(wù)代碼。

六、豐富的實用能力

1、接口數(shù)據(jù) Mock：

內(nèi)置 Mock.js 規(guī)則引擎，非常方便 Mock 出各種數(shù)據(jù)，并且可以在定義數(shù)據(jù)結(jié)構(gòu)的同時寫好 mock 規(guī)則。支持添加“期望”，根據(jù)請求參數(shù)返回不同 mock 數(shù)據(jù)。最重要的是 Apifox 零配置 即可 Mock 出非常人性化的數(shù)據(jù)。

2、Apifox 如何做到高效率、零配置生成非常人性化的 mock 數(shù)據(jù)

- Apifox 根據(jù)接口定義里的數(shù)據(jù)結(jié)構(gòu)、數(shù)據(jù)類型，自動生成 mock 規(guī)則。

- Apifox 內(nèi)置智能 mock 規(guī)則庫，根據(jù)字段名、字段數(shù)據(jù)類型，智能優(yōu)化自動生成的 mock 規(guī)則。如：名稱包含字符串image的string類型字段，自動 mock 出一個圖片地址 URL;包含字符串time的string類型字段，自動 mock 出一個時間字符串;包含字符串city的string類型字段，自動 mock 出一個城市名。

- Apifox 根據(jù)內(nèi)置規(guī)則，可自動識別出圖片、頭像、用戶名、手機號、網(wǎng)址、日期、時間、時間戳、郵箱、省份、城市、地址、IP 等字段，從而 Mock 出非常人性化的數(shù)據(jù)。

- 除了內(nèi)置 mock 規(guī)則，用戶還可以自定義規(guī)則庫，滿足各種個性化需求。支持使用 正則表達式、通配符 來匹配字段名自定義 mock 規(guī)則。

3、數(shù)據(jù)庫操作：

支持讀取數(shù)據(jù)庫數(shù)據(jù)，作為接口請求參數(shù)使用。支持讀取數(shù)據(jù)庫數(shù)據(jù)，用來校驗(斷言)接口請求是否成功。

4、接口自動化測試：

提供接口集合測試，可以通過選擇接口(或接口用例)快速創(chuàng)建測試集。

七、云端團隊協(xié)作

接口信息云端實時同步更新，天生響應(yīng)團隊協(xié)作。成熟的團隊/項目/成員權(quán)限管理系統(tǒng)滿足各類企業(yè)的需求。數(shù)據(jù)模型之間支持相互引用，同樣的數(shù)據(jù)結(jié)構(gòu)，只需要定義一次即可多處使用;修改時僅需修改一處，多處實時更新。

八 、兼容多種數(shù)據(jù)格式

1、支持導(dǎo)出 OpenApi (Swagger)、Markdown、Html 等數(shù)據(jù)格式，因為可以導(dǎo)出OpenApi格式數(shù)據(jù)，所以你可以利用 OpenApi (Swagger) 豐富的生態(tài)工具完成各種接口相關(guān)的事情。

2、支持導(dǎo)入 OpenApi (Swagger)、Postman、apiDoc、HAR、RAML、RAP2、YApi、Eolinker、NEI、DOClever、ApiPost 、Apizza 、ShowDoc、API Blueprint、I/O Docs、WADL、Google Discovery等數(shù)據(jù)格式，方便舊項目遷移。

3、支持定時自動導(dǎo)入OpenApi (Swagger)、apiDoc、Apifox格式數(shù)據(jù)。