APIOps Helper是什么

APIOps Helper是在IntelliJ IDEA平台上开发的插件，可以自动识别IDEA中Java项目的代码，从中扫描出API并自动生成OpenAPI规范文档。

用户可以选择将API导出为本地OpenAPI规范文档，或者将API同步到APIOps平台上进行API协同管理。团队成员可实时管理或是查看API内容，实现团队内高效协作与API全生命周期管理。

用户使用APIOps Helper插件从本地代码中识别出API。

对于识别出的API，用户可以选择自动生成本地OpenAPI规范文档。

用户也可以选择上传API到APIOPs平台。

目前，APIOps Helper插件支持以下框架与规范：

• SpringBoot 1.x，2.x，3.x

• Swagger 2.x

• OpenAPI 3.0.x，3.1.x

除了使用IDEA插件的方式生成OpenAPI文档外，还有一些比较流行的开源框架也可以自动生成OpenAPI文档，但这些开源框底层通常采用Java反射机制获取Swagger注解中的信息。因此，要想生成文档，SpringBoot项目必须要先启动起来；而IDEA插件采用的是静态代码扫描的方式获取代码中关键信息，所以无需启动项目，这就为开发人员提供了便利（因为开发人员往往不太方便在本地启动一些大型项目）。

下表列举了一些常用的OpenAPI文档开源项目框架：

如何使用APIOps Helper

首先，在IDEA中安装APIOps Helper插件。

安装APIOps Helper插件

其次，在插件设置中配置APIOps平台的地址及token（可从APIOps平台个人中心获取）。

配置APIOps地址及token

接下来，打开后端SpringBoot项目代码，从代码模块右键菜单或者Controller代码右键菜单选择APIOps Helper。

代码页面选择APIOps Helper

然后，选中指定的API，可以选择Upload到APIOps平台，或者Export为本地文件（可选择JSON或者YAML）。

选中指定的API

最后，登录APIOps平台，管理上传过来的API。

在APIOps平台上管理API

APIOps Helper插件功能就为大家介绍到这里了，如果您有需要进一步视频讲解，或者您有更好的建议，欢迎联系我们反馈！