**1、介紹**

此前，接口管理采用的常用解決方案如：

- 使用 Swagger 管理 API 文檔
- 使用 Postman 調(diào)試 API
- 使用 mockjs 等工具 Mock API 數(shù)據(jù)
- 使用 JMeter 做 API 自動化測試

但是上述的管理方案存在很多問題，如：維護不同工具之間數(shù)據(jù)一致性非常困難、低效。并且這里不僅僅是工作量的問題，更大的問題是多個系統(tǒng)之間數(shù)據(jù)不一致，導致協(xié)作低效、頻繁出問題，讓開發(fā)測試人員痛苦不堪。

Apifox 是 API 文檔、API 調(diào)試、API Mock、API 自動化測試一體化協(xié)作平臺，**定位 Postman + Swagger + Mock + JMeter**。通過一套系統(tǒng)、一份數(shù)據(jù)，解決多個系統(tǒng)之間的數(shù)據(jù)同步問題。只要定義好 API 文檔，API 調(diào)試、API 數(shù)據(jù) Mock、API 自動化測試就可以直接使用，無需再次定義；API 文檔和 API 開發(fā)調(diào)試使用同一個工具，API 調(diào)試完成后即可保證和 API 文檔定義完全一致。高效、及時、準確！

## **2.1、新建項目**

在`團隊`欄目下，點擊`新建項目`，在彈出的對話框中填入合適的內(nèi)容后點擊`保存`按鈕：

隨后點擊剛才創(chuàng)建的項目名稱進入項目：

進入項目后可以根據(jù)實際的開發(fā)需要決定是否新建分組來做接口分類：

例如，按照功能模塊分類，則效果如下：

Apifox允許支持多級分組，如果需要繼續(xù)分組，可以在已有的分組后方點擊`...`繼續(xù)選擇`新建子分組`。

## **2.2、使用Apifox來mock數(shù)據(jù)**

在項目的開發(fā)過程中，后端因為工作量大，往往不能及時的給到接口給前端做研發(fā)調(diào)試，前端經(jīng)常需要自己去mock數(shù)據(jù)來進行本地的研發(fā)。雖然可以采用mockjs來制造假數(shù)據(jù)，但對于新手來講難度較大，上手比較困難，在Apifox下，mock數(shù)據(jù)的操作就比較簡單了。接下來我們以`用戶管理`模塊為例，制作一個`用戶列表`的mock數(shù)據(jù)模型。

步驟1：在`數(shù)據(jù)模型`選項卡下，新建`用戶管理`分組，用來與`用戶管理`接口對應

步驟2：新建`用戶列表`數(shù)據(jù)模型

> 數(shù)據(jù)模型：描述接口返回數(shù)據(jù)格式的一種方式，在與后端對接完接口設計規(guī)范后即可產(chǎn)出。

例如，我們與后端對接要求`用戶列表`接口需要返回以下基本信息：

```json
{
    "desc": "操作成功",
    "code": 200,
    "data": [
        {
            "id": "1",
            "name": "1號用戶",
            "mobile": "13312345678",
            "email": "airchina@website.com",
            "gender": 1,
            "status": 1,
            "head_img":""
        }
    ]
}
```

那么我可以根據(jù)上述的json在Apifox中按照如下方式進行數(shù)據(jù)模型的創(chuàng)建：

> 小提示：這里我們可以通過軟件界面中`JSON/XML智能識別/快捷導入`功能來快速生成基本結(jié)構(gòu)，然后根據(jù)需要做出適當?shù)恼{(diào)整得到以下效果。

由于列表中的記錄數(shù)往往比較多，這里我們還可以設置`data`中`items`的數(shù)量范圍，在`data`節(jié)點后面點擊小齒輪圖表，然后根據(jù)需要輸入數(shù)量范圍：

隨后點擊`預覽`檢查生成結(jié)果是否正確，如下則正常：

最后，當一個數(shù)據(jù)模型設計完畢后，記得點擊右上角的`保存`按鈕。

## **2.3、接口設計與調(diào)試**

在有數(shù)據(jù)模型后，我們還需要進行本地接口設計，確保數(shù)據(jù)模型可以使用。

步驟1：進入`接口管理`選項卡，在對應的分組后面，點擊`+`來新建接口，并將環(huán)境切換為`Mock服務`，在本界面填入接口的基本信息，隨后點擊`保存`按鈕

步驟2：點擊`修改文檔`，將返回的`根節(jié)點`改為與之對應的數(shù)據(jù)模型（根據(jù)實際情況，修改請求頭和參數(shù)信息）

步驟3：點擊`修改文檔`底部的`創(chuàng)建示例`按鈕，選擇成功示例，點擊`確定`，再點擊右上角`保存`來完善接口文檔

步驟4：接口調(diào)試

如果該步驟能夠成功返回數(shù)據(jù)，那么我們就可以在Vue或React等開發(fā)環(huán)境中先使用`實際請求`中的`請求URL`進行AJAX請求來獲取模擬的業(yè)務數(shù)據(jù)，該地址支持跨域請求：

上述地址在瀏覽器中的請求效果：

## **2.4、接口分享**

Apifox還支持將寫好的接口分享給其他人，這樣就很方便將資源進行共享了。

**3、寫在最后**

Apifox這款開發(fā)神器，功能遠遠不僅僅只是快速Mock數(shù)據(jù)，其還支持很多開發(fā)中實用的功能，例如：前置操作、后置操作、持續(xù)集成、代碼生成等，它還有更多的功能等著你去發(fā)現(xiàn)！更多關于“web前端培訓”的問題，歡迎咨詢千鋒教育在線名師。千鋒已有十余年的培訓經(jīng)驗，課程大綱更科學更專業(yè)，有針對零基礎的就業(yè)班，有針對想提升技術的提升班，高品質(zhì)課程助理你實現(xiàn)夢想。