文章目录
- easyyapi插件使用
- 1. 安装插件
- 2. 配置插件
- 3. 编写javadoc
- 4. 上传接口javadoc
- 5. 登录YApi,查看项目接口
easyyapi插件使用
1. 安装插件
打开idea的Settings–>Plugins,查找easyyapi插件安装。
2. 配置插件
安装成功后,再次打开Settings–>OtherSettings,配置yapi服务地址以及项目token.
tokens: 项目名=token
token从项目设置里获取
3. 编写javadoc
配置完成后,可参考官方demo,编写javadoc。
官方说明地址:https://easyyapi.com/documents/java_doc_demo.html
该插件目前仅支持springweb原生注解,获取控制器的请求方式,自定义注解不支持
4. 上传接口javadoc
编写完成后,选中要上传的Controller,下拉idea code选项,选择ExportYapi
也可选择单个接口上传,右键
执行结果:
5. 登录YApi,查看项目接口