前言
當我們開發需要測試接口時,會遇到以下幾個問題
1.如果接口過多,參數過多,一個個參數復制到postman簡直能要了我的狗命,重復勞動過多.
2.如果接口過多,參數過多,編寫接口文檔給測試人員或者前端,又特么要命.
於是這里安利一款idea插件easyyapi,能一鍵幫我們解決以上問題
GitHub地址
https://github.com/tangcent/easy-yapi
功能特性
- 導出API文檔到
Postman - 導出API文檔到
Yapi - 導出API文檔到
Markdown - 導出RPC文檔到
Yapi - 導出RPC文檔到
Markdown - 在
IDEA中直接發起API請求 - Api DashBoard
- YApi DashBoard
解讀一下,第一個就是能直接把接口測試信息同步到你的postman帳號上,直接運行測試即可.
yapi類似 swagger的一個生成接口文檔平台.沒用過,但是也是可以一鍵同步過去
第三就很舒服了,可以導出API成markdown格式文件,樣式還很好看.
Typora打開markdown文檔還可以導出為PDF,簡直福利有木有.
再安利一個PDF轉word文檔的在線地址(https://app.xunjiepdf.com/pdf2word/)
環境
- IDEA
- SpringMVC
安裝
idea插件庫地址
https://plugins.jetbrains.com/plugin/12458-easyyapi/
或者直接在idea插件中搜索easyyapi
使用
因為我們要同步接口信息到postman,因此我們要先配置postman
先獲取密鑰
https://web.postman.co/settings/me/api-keys
再配置下token
生成
插件是根據什么生成的呢?
1.路徑: @RequestMapping() 識別改注解生成路徑,類及方法上
2.請求方式: @PostMapping 或者@GetMapping
3.請求請求協議: @RequestBody則以Json
4.返回響應協議: @RestController 或者 @ResponseBody 返回Json
右鍵點擊生成,或者快捷鍵alt+insert
效果如下,注意因為這里接口是加了@RequestBody因此為json請求,所以請求體在body中
導出markdown
操作方法和以上一致
不過注意一個問題就是生成選擇保存路徑時,文件名字會固定為easy-api.md
因此生成多個md文檔時記得及時備份改名,否則會被覆蓋
Typora支持導出各種格式,在配合在線格式轉換工具能很大程度提高我們的效率
https://app.xunjiepdf.com/pdf2word/
