接口API插件

Easy-yapi使用说明

Easy-yapi作为一款java接口文档自动生成的插件，包含了根据接口注释或注解自动生成接口文档，可网页打开，使用spring+vue开发，告别传统手写接口文档，告别swagger臃肿视图和阉割功能，提供了生成、管理及使用等全方位功能。

场景应用方面，可以提高后端维护接口文档的效率

插件安装

1. 在idea的plugin中搜索easy-yapi插件

   

2. 安装后重启软件

插件应用

1. Other Settings维护yapi网址

打开setting，在Other Settings下出现EasyApi菜单项，点开出现如下界面 server中维护公司yapi网址：http://192.168.0.55:3000/

2. 检查字段注释及控制层注释（接口入参dto以及出参dto需要加上如下注释，否则无法获取字段备注）

3. 找到对应的controller类文件位置 alt+shift+e

• 选择对应的接口

  

• 点击绿色箭头会出现如下弹层

  

• 输入token（找到对应yapi维护项目的token,复制token到4.2弹层输入框中）

  

• 输入token之后，回车，检查yapi对应项目下是否新增接口

  

​

• 调整相关字段确定信息和接口信息即可

注意事项

​ Easy-yapi是按照模块来的，如果一个模块接口需要维护在不同的yapi项目中，可以清除之前的tokens信息

​