比POSTMAN更好用！在國產接口調試工具APIPOST中使用Mock

2021 年 8 月 5 日
筆記
接口調試工具

APIPOST可以讓你在沒有後端程序的情況下能真實地返回接口數據，你可以用APIPOST實現項目初期純前端的效果演示，也可以用APIPOST實現開發中的數據模擬從而實現前後端分離。在使用APIPOST之前，你的團隊實現數據模擬可能是下面的方案中的一種或者多種：

本地手寫數據模擬，在前端代碼中產生一大堆的mock代碼。
利用mockjs或者canjs的can-fixture實現ajax攔截，本地配置必要的json規則。
後端在Controller層造假數據返回給前端。

上面的方式中，不管哪一種方式，都會要求開發人員寫一些跟項目本無任何關聯的代碼，第一個和第二個方式還會需要前端項目在本地引入不必要的js文件。

使用APIPOST 的Mock 服務

您可以通過APIPOST 提供的Mock 服務實現上述功能。

編寫Mock 規則

在APIPOST中，Mock 規則模板支持類型豐富（5.4版本起）。

基本數據(固定json結構)

{
  "code": "0",
  "data": {
    "name": "張三丰",
    "age": 100
  },
  "desc": "成功"
}

基本數據(Mock隨機json結構)

{
  "code": "0",
  "data": {
    "list|20": [{
      "name": "@name",
      "age": "@integer(2)"
    }],
    "url": "//echo.apipost.cn"
  },
  "desc": "成功"
}

RESTFUL邏輯數據

某些場景中，我們可能需要根據接口的入參規則，加入適當的邏輯處理後再返回數據。一個簡單的場景就是登錄場景，需要根據用戶名密碼，判斷是否登錄成功。再或者，我們需要根據產品ID動態返回產品信息，等等。

現在，ApiPost 的Mock 服務提供了這種場景的解決方案。
以下示例中，我們用到了 _req.body對象，其含義是：

當 post 請求以 x-www-form-urlencoded 或者application/json 方式提交時，我們可以拿到請求的參數對象。

{
  "code": "0000",
  "data": {
    "verifySuccess": function() {
      let body = _req.body;
      return body.username === 'admin' && body.password === '123456';
    },
    "userInfo": function() {
      let body = _req.body;
      if (body.username === 'admin' && body.password === '123456') {
        return Mock.mock({
          username: "admin",
          email: "@email",
          address: "@address"
        });
      } else {
        return null;
      }
    },
  },
  "desc": "成功"
}

填寫Mock URL 相對地址

Mock URL相對地址是必填項（如果不填寫的話，無法正常得到響應結果）。您可以通過在設置里開啟「自動獲取Mock URL地址」來自動獲取Mock URL。

此項開啟後，APIPOST將根據您輸入的接口URL自動截取PATH部分作為Mock URL的相對路徑。

利用APIPOST發送Mock URL

完成以上2步後，您可以通過在APIPOST中切換到「Mock 環境」來發送查看mock返回的詳細數據。

將生成的mock URL地址發給前端

您可以將APIPOST生成的mock URL地址發給前端來代替您的接口地址，這樣前端就可以使用您模擬的數據進行先一步的調試開發了。當您的接口完成後，再替換回來即可。

APIPOST的 mock 是基於mock.js 開發的。具體文檔可以參見 mock.js 詳細文檔。

Tags: 接口調試工具