快速測試 API 介面的新技能

樑桂釗發表於2018-05-06
API

原文地址：樑桂釗的部落格

部落格地址：blog.720ui.com

在日常開發過程中，我們或多或少都涉及到 API 介面的測試。例如，有的小夥伴使用 Chrome 的 Postman 外掛，或者使用火狐的 restclient 等工具。事實上，這些工具是測試 API 介面非常有效的方式之一，筆者之前也一直使用 Postman 完成 API 介面的測試工作。今天，筆者推薦另外一個非常好用的小工具，能夠幫助讀者快速測試 API 介面。這個工具就是 IDEA 的 Editor REST Client。

IDEA 的 Editor REST Client 在 IntelliJ IDEA 2017.3 版本就開始支援，在 2018.1 版本新增了很多的特性。事實上，它是 IntelliJ IDEA 的 HTTP Client 外掛。

開始工作

首先，我們可以在任意目錄下建立一個 xxx.http 檔案。，如圖所示。

快速測試 API 介面的新技能

這裡，三個 ### 進行 HTTP 請求分割。事實上，一個檔案可以包含多個 HTTP 請求， ### 後面可以新增註釋，案例如下所示。

### 使用者登入
POST http://localhost:8088/oauth/token?grant_type=password&username=lgz&password=123456
Accept : application/json
Content-Type : application/json;charset=UTF-8
Authorization: Basic client secret
Cache-Control : no-cache
複製程式碼

因此，我們獲得的響應內容。

快速測試 API 介面的新技能

多環境配置

在開發過程中，我們通常會存在多套環境，例如開發環境、*測試環境、預發環境、生產環境等。因此，如果 Editor REST Client能夠像 Postman 一樣做到多環境配置就太棒了。事實上， Editor REST Client 已經支援了這個特性，我們只需要建立 rest-client.env.json 檔案，並且配置多環境資訊即可。

{
  "development" : {
    "url" : "http://localhost:8088",
    "token" : "Bearer 4d74c7fb-0ef4-45ec-b3ff-902eaa3d116c"
  },
  "test" : {
    "url" : "http://localhost:8089",
    "token" : "Bearer 4d74c7fb-0ef4-45ec-b3ff-902eaa3d116c"
  },
  "preproduction" : {
    "url" : "http://activity.720ui.com",
    "token" : "Bearer 4d74c7fb-0ef4-45ec-b3ff-902eaa3d116c"
  },
  "product" : {
    "url" : "http://activity.720ui.com",
    "token" : "Bearer 4d74c7fb-0ef4-45ec-b3ff-902eaa3d116c"
  }
}
複製程式碼

此時，改造之前的 URL，將 http://localhost:8088 改造成 {{url}} 代替。

POST {{url}}/oauth/token?grant_type=password&username=lgz&password=123456
複製程式碼

這裡，我們獲得的整體效果。

快速測試 API 介面的新技能

案例詳解

現在，我們來寫一個完整的案例。具體配置可以參考：REST Client

### 建立使用者資訊
POST {{url}}/v1/m/users
Accept : application/json
Content-Type : application/json;charset=UTF-8
Authorization: {{token}}
{
    "username": "xiaoyue",
    "realname": "小嶽",
    "password": "111111",
    "email": "lianggzone@163.com",
    "tel": "18305930000",
    "weixin": "LiangGzone",
    "sex": 1
}

### 修改使用者資訊
PUT {{url}}/v1/m/users/723181
Accept : application/json
Content-Type : application/json;charset=UTF-8
Authorization: {{token}}
CachePATCH-Control : no-cache
{
    "username": "xiaoyue"
}

### 查詢使用者資訊
GET {{url}}/v1/c/users/lgz/username
Accept : application/json
Content-Type : application/json;charset=UTF-8
Authorization: {{token}}

### 查詢使用者資訊列表
GET {{url}}/v1/c/users?keyword=樑
Accept : application/json
Content-Type : application/json;charset=UTF-8
Authorization: {{token}}
複製程式碼

參考資料

（完，轉載請註明作者及出處。）

更多精彩文章，盡在「服務端思維」微信公眾號！

image

邀請您的加入我的星球，一群同頻者，一起成長，一年後，再回頭看看曾經的自己。

image

相關文章