快速測試 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 文件。，如圖所示。

這裏，三個 ### 進行 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
複製代碼

所以，咱們得到的響應內容。

多環境配置

在開發過程當中，咱們一般會存在多套環境，例如開發環境、*測試環境、預發環境、生產環境等。所以，若是 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
複製代碼

這裏，咱們得到的總體效果。

案例詳解

如今，咱們來寫一個完整的案例。具體配置能夠參考：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}}
複製代碼

參考資料

• marketplace.visualstudio.com/items?itemN…

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

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

邀請您的加入個人星球，一羣同頻者，一塊兒成長，一年後，再回頭看看曾經的本身。