Apifox for Mac(API接口調(diào)試工具) v2.6.7官方版

Apifox mac版是一款適用于macOS系統(tǒng)的API接口調(diào)試工具，集API文檔、API調(diào)試、API Mock、API自動(dòng)化測試多項(xiàng)實(shí)用功能為一體，定位為 Postman + Swagger + Mock + JMeter，可以通過一套系統(tǒng)、一份數(shù)據(jù)，解決多個(gè)工具之間的數(shù)據(jù)同步問題，從而幫助用戶快速生成接口請求、文檔、代碼，并進(jìn)行自動(dòng)化測試和數(shù)據(jù)導(dǎo)入導(dǎo)出。不僅僅如此，軟件功能十分的強(qiáng)大，如：支持如環(huán)境變量、預(yù)執(zhí)行腳本、后執(zhí)行腳本、Cookie/Session 全局共享等功能，可以說非常適合前端測試人員使用。

使用Apifox，用戶可以設(shè)計(jì)出新的接口，讓您的程序和系統(tǒng)都能夠正常的訪問數(shù)據(jù)，甚至還可以直接在Apifox軟件中編輯新的接口內(nèi)容，用戶在定義文檔之后直接使用數(shù)據(jù)，以及能夠調(diào)試接口的時(shí)候直接使用接口文檔，完全是不需要再次定義新的文檔內(nèi)容的哦。此外在這里用戶只需要定義好API文檔、API調(diào)試、API數(shù)據(jù)Mock以及API自動(dòng)化測試就可以直接進(jìn)行使用，完全不需要再次進(jìn)行定義，其中API文檔和API開發(fā)調(diào)試可以使用同一個(gè)工具，在API調(diào)試之后就即可保證和API文檔定義完全一致，使用起來非常的高效、及時(shí)、準(zhǔn)確，有感興趣的朋友可以來本站下載。

軟件功能

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

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

API 文檔和 API 開發(fā)調(diào)試使用同一個(gè)工具，API 調(diào)試完成后即可保證和 API 文檔定義完全一致。高效、及時(shí)、準(zhǔn)確！

二、可視化 API 設(shè)計(jì)

1、高效 & 零學(xué)習(xí)成本

可視化 API 文檔設(shè)計(jì)功能，無需手寫 Markdown 或 YAML，零學(xué)習(xí)成本，高效便捷。

2、可復(fù)用的“數(shù)據(jù)模型”

可將常用數(shù)據(jù)結(jié)構(gòu)定義為“數(shù)據(jù)模型”，在多個(gè)接口中引用，一次修改全局生效。

3、遵循 OpenAPI(Swagger) 規(guī)范

接口文檔完全遵循 OpenAPI(Swagger) 規(guī)范，支持 JSON Schema

4、可導(dǎo)入 Swagger 等 20+ 數(shù)據(jù)格式

支持導(dǎo)入 Swagger (OpenAPl) , Postman, Jmeter, apiDoc, RAP2, YApi, Eolink, Apipost 等數(shù)據(jù)格式。

三、比 Postman 更強(qiáng)大

1、一鍵調(diào)試，無需復(fù)制黏貼

只要設(shè)計(jì)完（或?qū)耄〢PI 文檔，即可一鍵調(diào)試，無需復(fù)制黏貼各種 URL 或參數(shù)。

2、“自動(dòng)校驗(yàn)”返回?cái)?shù)據(jù)結(jié)構(gòu)的正確性

依據(jù)接口文檔自動(dòng)判斷返回?cái)?shù)據(jù)結(jié)構(gòu)是否正確，無需手寫斷言。

3、獨(dú)創(chuàng)的“接口用例”功能

保存多組接口請求參數(shù)，輕松覆蓋一個(gè)接口的各種實(shí)例，方便后端自測和測試編寫用例。

4、全面兼容 Postman 功能和腳本語法

Postman 的接口前置腳本和測試腳本可以直接在 Apifox 內(nèi)運(yùn)行，并支持引用公共腳本。

5、支持 JS/Java/Python/PHP 等語言

腳本中支持引用 JS/Java/Python/PHP 等語言的包。

四、零門檻實(shí)現(xiàn)自動(dòng)化測試

1、可視化編排測試步驟，零代碼

支持可視化地編排自動(dòng)化測試步驟，無需手寫腳本代碼。

2、API 文檔基礎(chǔ)上，一鍵導(dǎo)入，實(shí)時(shí)同步

基于設(shè)計(jì)好的 API 文檔，一鍵導(dǎo)入，自動(dòng)生產(chǎn)“自動(dòng)化測試用例”，無需手動(dòng)添加，并且 API 變更實(shí)時(shí)自動(dòng)同步。

3、可視化添加斷言，支持讀寫數(shù)據(jù)庫

接口用例支持可視化的斷言，也可連接MySQL等多種數(shù)據(jù)庫讀寫數(shù)據(jù)。

4、支持“數(shù)據(jù)驅(qū)動(dòng)”測試

可導(dǎo)入CSV/JSON 格式的測試數(shù)據(jù)，使用測試數(shù)據(jù)運(yùn)行測試用例并產(chǎn)出測試報(bào)告。

5、支持 CI/CD 持續(xù)集成

支持使用命令行方式運(yùn)行測試用例并產(chǎn)出測試報(bào)告，可與 Jenkins等持續(xù)集成工具打通使用。

五、分享&發(fā)布 API 文檔

1、一鍵發(fā)布&分享

設(shè)計(jì)完（或?qū)耄?的API 文檔，一鍵分享給合作伙伴，接口變更實(shí)時(shí)同步，支持公開或加密發(fā)布。

2、API 文檔支持“在線調(diào)試”

API 文檔頁面支持“調(diào)試”功能，可以在線請求真實(shí)接口并返回?cái)?shù)據(jù)。

3、自定義導(dǎo)航、自定義樣式

API 文檔可自定義導(dǎo)航和頁面樣式，可以將 API 文檔的導(dǎo)航條做成跟官網(wǎng)一致。

4、個(gè)性化域名、自定義域名

支持自定義的 Apifox 文檔域名，也可綁定到自有的域名。

5、自動(dòng)生成代碼

在線文檔支持生成20 多種語言的接口請求代碼和數(shù)據(jù)模型代碼。

六、零配置 Mock 數(shù)據(jù)

1、無需手寫 Mock 規(guī)則

只要定義好 API 文檔，“零配置”即可自動(dòng) mock 出非常“人性化”的數(shù)據(jù)（根據(jù)數(shù)據(jù)結(jié)構(gòu)及字段名智能 mock）

2、API 變更后 Mock 數(shù)據(jù)實(shí)時(shí)同步變更

API 文檔更改時(shí)，Mock 數(shù)據(jù)會(huì)自動(dòng)變更，無需改動(dòng)任何腳本。

3、支持根據(jù)請求參數(shù)返回不同結(jié)果

高級 Mock 支持配置不同的期望，根據(jù)請求參數(shù)返回不同結(jié)果。

4、內(nèi)置 Mock.js 規(guī)則引擎

內(nèi)置 Mock.js 規(guī)則引擎，可自定義符合 Mock.js 語法的 Mock 腳本。

5、支持自定義腳本 Mock

自定義腳本 Mock 支持二次修改智能 Mock 的結(jié)果，實(shí)現(xiàn) Mock 字段之間的邏輯關(guān)聯(lián)。

Apifox基本使用教程

一、如何解決這些問題

1、定位

Apifox = Postman + Swagger + Mock + JMeter

它是 API 文檔、API 調(diào)試、API Mock、API 自動(dòng)化測試一體化協(xié)作平臺(tái)。

通過一套系統(tǒng)、一份數(shù)據(jù)，解決多個(gè)系統(tǒng)之間的數(shù)據(jù)同步問題。只要定義好接口文檔，接口調(diào)試、數(shù)據(jù) Mock、接口測試就可以直接使用，無需再次定義；接口文檔和接口開發(fā)調(diào)試使用同一個(gè)工具，接口調(diào)試完成后即可保證和接口文檔定義完全一致。高效、及時(shí)、準(zhǔn)確！

2、宗旨

節(jié)省研發(fā)團(tuán)隊(duì)的每一分鐘！

二、Apifox 做的不僅僅是數(shù)據(jù)打通

如果你認(rèn)為該軟件只做了數(shù)據(jù)打通，來提升研發(fā)團(tuán)隊(duì)的效率，那就錯(cuò)了還做了非常多的創(chuàng)新，來提升開發(fā)人員的效率。

1、接口支持“用例管理”

通常一個(gè)接口會(huì)有多種情況用例，比如正確用例參數(shù)錯(cuò)誤用例數(shù)據(jù)為空用例不同數(shù)據(jù)狀態(tài)用例。定義接口的時(shí)候定義好這些不同狀態(tài)的用例，接口調(diào)試的時(shí)候直接運(yùn)行，非常高效。

2、“數(shù)據(jù)模型”定義、引用

可以獨(dú)立定義數(shù)據(jù)模型，接口定義時(shí)可以直接引用數(shù)據(jù)模型，數(shù)據(jù)模型之間也可以相互引用。同樣的數(shù)據(jù)結(jié)構(gòu)，只需要定義一次即可多處使用；修改的時(shí)候只需要修改一處，多處實(shí)時(shí)更新，避免不一致。

3、調(diào)試時(shí)“自動(dòng)校驗(yàn)”數(shù)據(jù)結(jié)構(gòu)

使用它調(diào)試接口的時(shí)候，系統(tǒng)會(huì)根據(jù)接口文檔里的定義，自動(dòng)校驗(yàn)返回的數(shù)據(jù)結(jié)構(gòu)是否正確，無需通過肉眼識別，也無需手動(dòng)寫斷言腳本檢測，非常高效！

4、“可視化”設(shè)置斷言

設(shè)置斷言：

運(yùn)行后，查看斷言結(jié)果：

5、“可視化”設(shè)置提取變量

6、支持?jǐn)?shù)據(jù)庫操作

7、“零配置”Mock 出非常人性化的數(shù)據(jù)

先放一張圖對比下 Apifox 和其他同類工具零配置mock 出來的數(shù)據(jù)效果：

Apifox Mock 數(shù)據(jù)結(jié)果對比同類工具

可以看出零配置Mock 出來的數(shù)據(jù)和真實(shí)情況是非常接近的，前端開發(fā)可以直接使用，而無需再手動(dòng)寫 mock 規(guī)則。

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

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

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

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

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

8、生成在線接口文檔

項(xiàng)目可“在線分享” API 文檔，分享出去的 API 文檔可設(shè)置為公開或需要密碼訪問，非常方便與外部團(tuán)隊(duì)協(xié)作。

9、代碼自動(dòng)生成

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

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

10、導(dǎo)入、導(dǎo)出

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

支持導(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ù)格式，方便舊項(xiàng)目遷移。

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

常見問題

1、使用 Postman 調(diào)用接口返回正常，而返回錯(cuò)誤

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

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

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

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

2、同項(xiàng)目下有不同域名的接口，如何處理？

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

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

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

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

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

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

優(yōu)先級順序如下：臨時(shí)變量>環(huán)境變量>全局變量。

更新日志

v2.6.7版本

【新功能】HTTP 項(xiàng)目 支持 接口版本 的創(chuàng)建與管理，包括全量的 HTTP 接口、數(shù)據(jù)模型、響應(yīng)組件、Markdown 文檔 資源

【新功能】可以創(chuàng)建 通用接口文檔 來管理自定義協(xié)議的文檔，支持配置協(xié)議名稱和唯一標(biāo)識，支持 在線分享

【新功能】可以配置接口目錄在 在線文檔 中的展示方式，可選項(xiàng)為普通目錄、模塊標(biāo)題、跳轉(zhuǎn)到子目錄

【新功能】可以 定時(shí)導(dǎo)入 YApi 格式的數(shù)據(jù)

【優(yōu)化】調(diào)試接口、用例時(shí)，在發(fā)送請求之前，默認(rèn)折疊 返回響應(yīng) 區(qū)域

【優(yōu)化】調(diào)試接口、用例時(shí)，如果光標(biāo)在地址欄內(nèi)，可以直接通過回車鍵發(fā)送請求

【優(yōu)化】導(dǎo)入 Markdown 文檔時(shí)，如果目錄和名稱都相同，則視為同名文件

解決暫停自動(dòng)化測試再繼續(xù)運(yùn)行時(shí)，某些情況下報(bào)錯(cuò)的問題

解決導(dǎo)入 ShowDoc 格式的數(shù)據(jù)時(shí)，某些情況下報(bào)錯(cuò)的問題

解決導(dǎo)入 apiDoc 格式的數(shù)據(jù)時(shí)，某些情況下界面失去響應(yīng)的問題