IntelliJ IDEA 的 EasyYapi 插件是一个基于 javadoc & KDoc & ScalaDoc 解析 API 文档的插件,可以在保持代码零侵入的情况下得到相当完整的 api 文档(特殊的需求还是需要部分特殊的注释/注解配合),支持导出文件中的 API 到yapi
/postman
/markdown
,以及在 IDEA 中直接发起文件中的 API 请求进行接口调试
。
如果是 Spring 项目,我们可以选中一个或多个 @Controller
的 .java
文件来批量生成需要调试的接口,效果如下:
首先,我们需要在 IntelliJ IDEA 的插件市场中搜索并安装 EasyYapi 插件,安装成功后需要重启 IDEA:
然后,选中需要调试的 API 文件,鼠标右键选择Call Api
即可打开接口调试窗口对选中文件中的 API 发起请求进行接口调试。打开调试窗口后,我们选中用户登录接口,如下所示:
从上图可以看出,接口请求路径和请求数据格式都已经自动生成好了,我们只需要修改调试数据,然后点击运行按钮来发起 API 请求:
如果我们要导出文件中的 API 到 Yapi
/Postman
/Markdown
,需要选中一个或多个 @Controller
的 .java
文件然后鼠标右键选择Export Api
(也可以直接选择Export Yapi
/Export Postman
/Export Markdown
),如下所示:
生成的Markdown
API 文档效果如下: