idea的插件—可快速生成yapi的接口文檔（代碼0入侵）
1. 功能
- 導(dǎo)出http到（@Controller注解類）
- Yapi
- Postman
- markdown
- 導(dǎo)出RPC到
- Yapi
- markdown
- Call api調(diào)用API接口
注意點(diǎn)：
- 注釋中可以使用
@module標(biāo)注模塊所屬的模塊磕瓷。表示接口會(huì)發(fā)布到y(tǒng)api模塊下丹拯； - 只能是類維度進(jìn)行api接口上傳烤低，建議每個(gè)類（Controller）根據(jù)業(yè)務(wù)維度設(shè)計(jì)脐雪，不要混亂翘悉。
2. 常用使用
2.1 安裝
Preferences → Plugins → Marketplace → 搜索“EasyYapi” → 安裝該插件 → 重啟IDE
2.2 idea配置
使用下面的方式獲取token信息领追，并配置在idea中忽冻。
image.png
2.2.1 postman請(qǐng)求
生成postman的token
- postman的token,可以從Postman Integrations Dashboard獲得
image.png
在 API 文件類中使用 快捷鍵 Ctrl+Enter 選擇 ExportPostman.(Mac使用
control+Entry)生成的格式
image.png
2.2.2 Yapi請(qǐng)求
- 獲取Yapi的Token信息
image.png
- 需要聲明注釋
IDEA創(chuàng)建類模板和方法模板（超詳細(xì)）
/**
* @module Yapi的模塊名稱
*/
@RestController
@RequestMapping("/asa")
public class Aa {
@RequestMapping("/api")
public Order r(@RequestBody Order order) {
return order;
}
/**
* @ignore 該接口不生成Yapi文檔
*/
@RequestMapping("/api")
public TestTable1 r1(@RequestBody TestTable1 testTable1) {
return testTable1;
}
}
- 結(jié)果信息
conrrol+Entry導(dǎo)出Yapi配置
image.png
生成的結(jié)果.png
2.3 Call api調(diào)用
在 api/rpc 文件中 使用 快捷鍵 Ctrl+Enter 選擇 Call API , 發(fā)起對(duì)當(dāng)前文件中的API的請(qǐng)求芬沉。
image.png
