軟件介紹

Apifox離線版是一款專業實用的電腦API接口測試軟件，其擁有著可視化接口管理、接口調試、自動校驗數據結構、自動化測試等豐富功能，致力于打造API一體化協作平臺，方便用戶對API的測試。另外，Apifox的功能非常的強大，甚至能夠通過一套系統或者一份數據解決多個系統之間的數據同步問題，讓API測試更加方便！

此外，Apifox多樣且全面的功能，能夠完美適用于前端開發、后端開發、后端代碼、測試人員等多個行業，有效的縮短了接口測試的流程，讓檢測過程更加的快捷！有需要的用戶快來下載使用吧！

軟件特色

可視化 API 設計

高效 & 零學習成本

可視化 API 文檔設計功能，無需手寫 Markdown 或 YAML，零學習成本，高效便捷。

可復用的“數據模型”

遵循 OpenAPI(Swagger) 規范

可導入 Swagger 等 20+ 數據格式

比 Postman 更強大

一鍵調試，無需復制黏貼

只要設計完（或導入）API 文檔，即可一鍵調試，無需復制黏貼各種 URL 或參數。

“自動校驗”返回數據結構的正確性

獨創的“接口用例”功能

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

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

API 自動化測試

API 文檔基礎上，一鍵導入，實時同步

基于設計好的 API 文檔，一鍵導入，自動生產“自動化測試用例”，無需手動添加，并且 API 變更實時自動同步。

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

可視化添加斷言，支持讀寫數據庫

支持“數據驅動”測試

支持 CI/CD 持續集成

一鍵發布&分享

設計完（或導入） 的API 文檔，一鍵分享給合作伙伴，接口變更實時同步，支持公開或加密發布。

API 文檔支持“在線調試”

自定義導航、自定義樣式

個性化域名、自定義域名

自動生成代碼

零配置 Mock 數據

無需手寫 Mock 規則

API 變更后 Mock 數據實時同步變更

支持根據請求參數返回不同結果

內置 Mock.js 規則引擎

支持自定義腳本 Mock

軟件功能

CI 持續集成

1.支持命令行方式運行 API 測試 (Apifox CLI)。

2.支持集成 Jenkins 等持續集成工具。

數據庫操作

1.支持讀取數據庫數據，作為 API 請求參數使用。

2.支持讀取數據庫數據，用來校驗(斷言) API 請求是否成功。

團隊協作

1.接口數據云端同步，實時更新。

2.成熟的團隊/項目權限管理，支持管理員、普通成員、只讀成員等角色設置，滿足各類企業的需求。

數據導入/導出

1.支持導出 OpenAPI (Swagger)、Markdown、Html 等數據格式。

2.支持導入 OpenAPI (Swagger)、Postman、HAR、RAP2、JMeter、YApi、Eolinker、NEI、RAML、DOClever 、Apizza 、DOCWAY、ShowDoc、apiDoc、I/O Docs、WADL、Google Discovery 等數據格式。

支持 HTTP、TCP、RPC

1.支持 HTTP(s) 接口管理。

2.支持 Socket (TCP) 接口管理。

3.后續將會支持 GraphQL、Dubbo、gRPC、WebSocket 等協議接口。

自動生成代碼

1.根據接口/模型定義，自動生成各種語言/框架的業務代碼和 API 請求代碼。

2.支持 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等 130 種語言及框架。

3.支持自定義代碼模板，自動生成符合自己團隊的架構規范的代碼，滿足各種個性化的需求。

Apifox離線版使用教程

一、注冊與登錄

使用Apifox前，您需要注冊一個Apifox賬戶。在Apifox官網首頁，單擊“Sign up”（注冊）按鈕，即可跳轉至注冊頁面。在頁面上填寫姓名、郵箱地址和密碼等信息，單擊“Sign up”按鈕即可完成注冊。

注冊完成后，您可使用郵箱地址和密碼登錄您的Apifox賬戶。

二、創建API項目

在進入Apifox主界面后，單擊頁面左上角的“新建API”按鈕，即可創建一個新的API項目。在彈出的“新建API項目”對話框中，填寫該API的名稱，選擇API的類型（REST、GraphQL或WebSocket），單擊“創建”按鈕，即可創建一個新的API項目。

三、添加API端點

創建一個API項目后，您需要添加API端點以定義API的行為。在API項目頁面中，單擊“添加端點”按鈕，即可添加一個新的API端點。在端點編輯器中，您可以定義API的請求方法、路徑、參數、請求體、響應和狀態碼等信息。此外，您還可以添加注釋和標簽以進一步解釋端點的行為和功能。

四、導入和導出API文檔

在使用Apifox期間，您可以將API文檔導入和導出Apifox，以便與其他系統或用戶共享您的API信息。在Apifox上為API文檔添加標簽后，您可以將整個API項目導出為JSON格式的文件，并在其他系統中導入該文件以恢復Apifox中的API文檔。此外，您還可以將您的API文檔導入到Apifox中，以便在Apifox編輯器中添加、編輯和刪除API端點。

五、分享API文檔

在創建和編輯API文檔后，您可以將其分享給其他團隊成員或開發者，以便更好地共同開發和測試API。在Apifox中，您可以將API文檔共享到您的社交媒體或在線群組中，并邀請其他團隊成員或開發者進行編輯和評論。

六、通過Mocks測試API

在完成API端點的設計后，您可以使用Apifox的Mocks功能測試API的行為和功能。使用Mocks，您可以模擬請求和響應，以驗證API端點是否按預期響應請求。在API編輯器中，單擊“Mocks”選項卡并定義模擬請求和響應后，您可以通過單擊“執行”按鈕運行測試用例，以測試您的API端點是否正確響應請求。

七、通過API文檔生成代碼

除了測試API端點的行為和功能之外，您可以使用Apifox的API工具將API端點轉換為代碼片段。使用API工具，您可以生成Java、Python、JavaScript等語言的API客戶端代碼，并將其添加到您的項目中以調用API。此外，API工具還支持自定義API請求體和響應的數據類型和格式化方式。

Apifox離線版服務對象

前端開發：

接口文檔管理、接口數據 Mock、接口調試、前端代碼自動生成

后端開發：

接口文檔管理、接口調試、接口自動化測試、后端代碼自動生成

測試人員：

接口調試、接口自動化測試

Apifox離線版快捷鍵分享

新建接口：Ctrl + N

新建快捷調試：Ctrl + T

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

發送請求：Ctrl + Enter

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

關閉Tab：Ctrl + W

強制關閉Tab：Ctrl + Alt + W

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

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

跳轉到特定標簽頁：Ctrl + 1 到 Ctrl + 8

跳轉到最后一個標簽頁：Ctrl + 9

導入數據 Ctrl + O：? + O

導入抓包數據 (cURL)：Ctrl + I

查找接口：Ctrl + F

Apifox離線版常見問題解答

1、Apifox 是否收費？

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

2、登錄（Auth）態如何實現？

請參考文檔：登錄態（Auth）如何處理

3、接口發送請求前需要調用登錄接口獲取 token 放在header，如何實現？

請參考文檔：登錄態（Auth）如何處理

4、B接口請求參數依賴于 A 接口返回的數據，如何實現？

請參考文檔：接口之間如何傳遞數據

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

方案一：在環境里新增多個服務，分別設置不同的前置 URL ,接口分組和接口維度可以指定對應的前置 URL。推薦本方案！

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

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