IDEA配合EasyYAPI完成维护YAPI接口的工作

小灰灰 2022-10-07 05:55 2637阅读 0赞

## IDEA配合EasyYAPI完成维护YAPI接口的工作 ##

EasyYapi的简介![在这里插入图片描述][20210616162633524.png]  
1.在 idea中添加EasyYapi插件  
file—>plugins-→EasyYapi—>install  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDQ3NjUyMA_size_16_color_FFFFFF_t_70]

2.配置EasyApi  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDQ3NjUyMA_size_16_color_FFFFFF_t_70 1]

配置的token可以等上传Yapi接口的时候进行配置

项目的token在  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDQ3NjUyMA_size_16_color_FFFFFF_t_70 2]  
每个项目都有一个token

类注释修改地址：File–>settings–>Editor–>File and Code Templates–>Files–>Class

类的注释配置为：

/** *@title: ${NAME} *@projectName ${PROJECT_NAME} *@Description TODO *@Author *@Date ${DATE} ${TIME} */

方法注释修改地址：File–>Settings–>Editor–>Live Templates  
新建一个分类  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDQ3NjUyMA_size_16_color_FFFFFF_t_70 3]  
在新建的分类下新建模板  
模板如下：

/** 　　* @description: TODO 　　* @param ${tags} 　　* @return ${return_type} 　　* @throws 　　* @author ${USER} 　　* @date $date$ $time$ 　　*/

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDQ3NjUyMA_size_16_color_FFFFFF_t_70 4]  
3.配置好之后可以在  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDQ3NjUyMA_size_16_color_FFFFFF_t_70 5]  
![在这里插入图片描述][20210616160355703.png]  
点击生成，或者按快捷键alt + shift + E 生成

接口文档和注释对应关系如图

对应字段实体类注释：  
![在这里插入图片描述][20210616160441172.png]  
![在这里插入图片描述][20210616160457921.png]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDQ3NjUyMA_size_16_color_FFFFFF_t_70 6]  
返回泛型的方法一定要写清楚返回的泛型的类型，否则返回参数不会生成

[20210616162633524.png]: /images/20221005/6b62ac7ba2004dd8959b9dfb3e41a340.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDQ3NjUyMA_size_16_color_FFFFFF_t_70]: /images/20221005/3151027ea79442feb87adf2a60a5d8cb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDQ3NjUyMA_size_16_color_FFFFFF_t_70 1]: /images/20221005/8bbfbe9cacfb4dfbbd0fc06da10d62e3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDQ3NjUyMA_size_16_color_FFFFFF_t_70 2]: /images/20221005/01b6da6e02074559a16e460cc9a51853.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDQ3NjUyMA_size_16_color_FFFFFF_t_70 3]: /images/20221005/c7429c7e6c894d3db785437c54e3046d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDQ3NjUyMA_size_16_color_FFFFFF_t_70 4]: /images/20221005/73da93853e054a538b6c7fdf37c47084.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDQ3NjUyMA_size_16_color_FFFFFF_t_70 5]: /images/20221005/0576dd514d81426e95284fcc089f8779.png
[20210616160355703.png]: /images/20221005/01b783ac07954279be2738a0286881c4.png
[20210616160441172.png]: /images/20221005/5a78fa8bdd7f45fdae95831cd7903b14.png
[20210616160457921.png]: /images/20221005/4ae7c7e55b0141949a00067af24ca2df.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDQ3NjUyMA_size_16_color_FFFFFF_t_70 6]: /images/20221005/6049a1d3f6394d8eb7f4a4042ab4a902.png