後端適用，Apifox介面文件設計和除錯教程

一.Apifox的工具優勢

對後端研發人員來說，Swagger+Postman 是介面設計和除錯的必備工具，這兩個工具都非常出色，

但不同系統間專案資料不互通，在變更、維護和協同上比較低效，另外是封裝程度較低，使用上流程較為繁瑣。

因此今天介紹一個 API 管理工具，一方面具備 Swagger 和 postman 的功能，一方面又針對上述問題做了最佳化，能夠提升在工作過程中的效率。

二. Apifox 做的改進

1. Apifox的整體功能定位

Apifox 是 API 文件、API 除錯、API Mock、API 自動化測試一體化協作平臺。Apifox = Postman + Swagger + Mock + JMeter.

對於後端同學，使用較多的是它的文件和除錯功能，同時可透過其協作功能與前端和測試同學同步資料，減少溝通成本。

2.相對比於 Swagger 的優勢

a.視覺化的介面文件設計和管理介面，上手和使用成本低

b.設計好的介面文件能直接在Apifox 中除錯，不需要再切換工具

c.介面和文件一體化，修改介面可同步修改文件，節省維護文件的精力

d. swagger 的核心功能 Apifox 基本都具備

3.相對比於 Postman 的優勢

a.介面文件功能和除錯功能一體，除錯和修改文件能節省掉切換工具和系統間同步資料的成本

b. Postman 的除錯功能 Apifox 都有

c. Apifox 對除錯功能的支援更強大，支援連線資料庫，呼叫第三方程式碼，視覺化斷言和提取介面變數

三. Apifox 功能介紹

1.專案匯入匯出功能

1.支援匯出 OpenApi(Swagger)、 Markdown、 Html 等資料格式，因為可以匯出 OpenApi格式資料，所以你可以利用 OpenApi (Swagger) 豐富的生態工具完成各種介面相關的事情。

2.支援匯入 OpenApi(Swagger)、 Postman、 apiDoc、 HAR、 RAML、 RAP2、 YApi、 Eolinker、 ApiPost 、 Apizza 、 ShowDoc、 WADL等20多種資料格式，方便舊專案遷移。

3.支援定時自動匯入 OpenApi(Swagger)、 apiDoc、 Apifox格式資料。

2.文件功能

2.1 視覺化文件功能

API 文件支援編寫 MarkDown格式的說明。

支援 Markdown 所見即所得地編寫非 API 文件的普通文件。

設計好的 API 可一鍵生成美觀的 API 文件。

2.2 資料模型

可複用的資料結構，定義介面返回資料結構及請求引數資料結構（僅 JSON 和 XML 模式）時可直接引用。支援模型直接巢狀引用，直接 JSON/XML 智慧匯入，支援 oneOf、allOf 等高階組合模式。

2.3 生成線上文件分享

API 文件可匯出為OpenAPI、Markdown、HTML等格式，方便離線分享。

API 文件支援密碼保護和生效時間，可生成多份不同內容和許可權的文件。

生成的文件可以在瀏覽器開啟，樣式十分整潔美觀

3. 除錯功能

Postman 有的功能，比如環境變數、前置/後置指令碼、Cookie/Session 全域性共享 等功能，Apifox 都有

資料庫操作：支援讀取資料庫資料，作為介面請求引數使用。支援讀取資料庫資料，用來校驗(斷言)介面請求是否成功。

自定義指令碼: 100% 相容 Postman 語法，並且支援執行 javascript、java、python、php、js、BeanShell、go、shell、ruby、lua 等各種語言程式碼。

視覺化斷言

前後置操作支援視覺化設定斷言，斷言可處理響應 Json、響應 XML、響應 Header、耗時等多種物件，可斷言是否等於、是否存在、是否包含、是否為空、正則匹配等邏輯。

提取變數

前後置操作支援提取變數，可從可從介面返回結果裡提取資料，設定到變數（臨時變數/環境變數/全域性變數），方便其他介面執行的時候直接使用。

4.自動生成程式碼

a.根據介面/模型定義，自動生成各種語言/框架的業務程式碼和 API 請求程式碼。

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

c.支援自定義程式碼模板，自動生成符合自己團隊的架構規範的程式碼，滿足各種個性化的需求

5.CI持續整合

支援命令列方式執行 API 測試 (Apifox CLI)。

支援整合 Jenkins 等持續整合工具。

6.協作功能

1.團隊成員共用一套介面資料，任何變更都能及時同步到各端，減少溝通成本和資料不一致的問題

2.擁有人員許可權管理功能，設定只讀和編輯，可維護專案資料安全

7. Apifox的其他功能

1.智慧mock

Apifox 內建智慧 mock引擎，囊括常用的資料mock規則，不需要編寫指令碼就能mock出高度真實的業務資料供前端除錯，同時支援使用者自定義 mock 規則。

2.自動化測試

支援引用 API 文件中定義的介面直接生成測試步驟。

支援引用介面用例直接生成測試步驟。

支援繫結介面，介面發生變化時，自動更新測試用例。

支援執行迴圈次數和用例之間設定時間間隔。

測試用例支援引數動態值。

支援自動生成測試報告