忘了 postman 是被誰種草的,很長一段時(shí)間內(nèi) postman 都是我做接口測(cè)試的首選工具,之前也有小伙伴跟我安利過 IDEA 中的 RestfulToolkit 插件,但是一直沒機(jī)會(huì)體驗(yàn),最近抽空玩了一把,感覺在某些場(chǎng)景下還蠻不錯(cuò)的(不需要認(rèn)證的場(chǎng)景下),和小伙伴們分享下。
1. RestfulToolkit
RestfulToolkit 是一套 RESTful 服務(wù)開發(fā)輔助工具集,它主要提供了如下功能:
- 根據(jù) URL 直接跳轉(zhuǎn)到對(duì)應(yīng)的方法定義 ( Ctrl \ or Ctrl Alt N );
- 提供了一個(gè) Services tree 的顯示窗口;
- 一個(gè)簡(jiǎn)單的 http 請(qǐng)求工具;
- 在請(qǐng)求方法上添加了有用功能: 復(fù)制生成 URL;,復(fù)制方法參數(shù)...
- 其他功能: java 類上添加 Convert to JSON 功能,格式化 json 數(shù)據(jù) ( Windows: Ctrl + Enter; Mac: Command + Enter )。
它支持 Spring 體系 (Spring MVC / Spring Boot 1.x,2.x);支持 JAX-RS;支持 Java 和 Kotlin 語言。
2. 安裝
在 IDEA 中選擇 File->Plugins,然后搜索 RestfulToolkit,如下:
然后點(diǎn)擊 install 按鈕即可,安裝完成后重啟 IDEA 即可:
3. 使用
創(chuàng)建一個(gè)項(xiàng)目,在項(xiàng)目的右邊可以看到 Rest Services 選項(xiàng),如下:
點(diǎn)開該選項(xiàng)卡,就可以進(jìn)行 RESTful 接口測(cè)試了。
松哥寫了四個(gè)測(cè)試接口,大家來看一下:
@RestController
public class BookController {
@PostMapping("/book")
public RespBean addBook(Book book) {
System.out.println(book);
return RespBean.ok("添加成功");
}
@GetMapping("/book/{id}")
public Book getBookById(@PathVariable Integer id) {
Book book = new Book();
book.setId(id);
return book;
}
@PutMapping("/book")
public RespBean updateBook(@RequestBody Book book) {
return RespBean.ok("更新成功");
}
@DeleteMapping("/book")
public RespBean deleteBookById(Integer id) {
return RespBean.ok("刪除成功");
}
}
這四個(gè)借口基本上涵蓋了我們?nèi)粘3R姷膫鲄⒎绞剑瑔?dòng)項(xiàng)目,我們來看下右邊:
可以看到,項(xiàng)目啟動(dòng)成功后,四個(gè)測(cè)試接口都會(huì)在 RestfulToolkit 工具中展示出來:
并且不同的接口,都有對(duì)應(yīng)的默認(rèn)參數(shù),例如更新接口,參數(shù)是 JSON 格式,這里就會(huì)自動(dòng)列出來:
開發(fā)者只需要根據(jù)實(shí)際情況重新填一下具體的參數(shù)值即可。
測(cè)試成功,結(jié)果如下:
RestfulToolkit 有一個(gè)功能,就是點(diǎn)擊接口,可以跳轉(zhuǎn)到對(duì)應(yīng)的方法定義上,如下:
選中接口,右鍵單擊,有兩個(gè)選項(xiàng):
- Copy Full Url:拷貝完整的 URL 地址。
- Jump to Source:跳轉(zhuǎn)到接口定義的代碼處。
除了這個(gè),RestfulToolkit 還能幫我們根據(jù)一個(gè)類,快速轉(zhuǎn)換為 JSON,有時(shí)候我們用 postman 測(cè)試的時(shí)候,自己寫 JSON 太慢了,這是一個(gè)好辦法,具體操作如下:
選中類名,右鍵單擊,最上面有兩個(gè)選項(xiàng),如下:
- Convert to JSON(Compressed):生成一個(gè)壓縮后的 JSON,其實(shí)就是一行 JSON。
- Convert to JSON:生成一個(gè)帶格式的 JSON。
4. 一個(gè)題外話
有的小伙伴可能會(huì)問,用 RestfulToolkit 的話,基于 Cookie+Session 的認(rèn)證怎么辦?其實(shí),一個(gè)合格的 RESTful 接口,本身就是無狀態(tài)的,既然是無狀態(tài)的,那么認(rèn)證就不需要 Cookie 了,每個(gè)請(qǐng)求都自己帶上令牌就行了,反正 RestfulToolkit 也支持修改請(qǐng)求頭。
不過話說回來,如果你的項(xiàng)目就是基于 Cookie + Session 認(rèn)證的,那么接口測(cè)試,我還是建議使用 postman,畢竟這個(gè)工具更專業(yè)。或者你也可以試試 IDEA 自帶的 Http Client 工具,如下圖:
好啦,今天和小伙伴們分享了一個(gè)小工具,感興趣的小伙伴可以去體驗(yàn)一把啦~對(duì)了,2020 版之后的 IDEA 可以使用 Restful Tools。