快速上手
Apifox Helper 是 Apifox 团队针对 IntelliJ IDEA 环境所推出的插件，可以在 IDEA 环境中识别本地 Java、Kotlin 后端项目的源代码，自动生成 API 文档并一键同步到 Apifox 的项目中。Apifox Helper 插件能够做到开箱即用，实现真正的代码零侵入。如下图所示，仅通过识别最基本的 SpringBoot 代码，即可生成一份详尽的 API 文档。
| 类型 | 名称 | 注解示例 |
|---|---|---|
| 服务端框架 | • Spring • Jakarta RESTful Web Services (JAX-RS) | @RestController, @GetMapping @Path, @Get |
| 校验库 | • Jakarta Bean Validation • Java Bean Validation | @NotNull |
| 序列化库 | • FASTJSON • Jackson • GSON | @JsonProperty @SerializedName |
| API 规格库 | • Swagger 2.x • Swagger/OpenAPI 3.x | @ApiOperation, @ApiParam |
| 客户端库 | • Spring Cloud OpenFeign | |
| 性能指标库 | • Spring Boot Actuator | |
| 语言与注释 | • Java: Javadoc • Kotlin: KDoc |
📌
下载与安装
配置 API 访问令牌
Apifox Helper 插件之前，需要提前注册 Apifox 账号，并生成对应的 API 访问令牌，详细说明请参考《Apifox 开放 API》。Apifox Helper 内填写自己的 API 访问令牌，然后点击「测试令牌」。如果测试成功，请点击「应用」或「确定」按钮，然后正常使用 Apifox Helper。同步接口
注意事项
Apifox Helper 旧版本中所提供的，通过输入文字来指定上传的目标目录方式将被废弃。如果你使用该方式指定目录，当项目内的其他目录存在相同接口时，有可能出现以下问题：查看接口文档
常见问题
为什么网络连接正常，但是点击「测试令牌」或上传接口时，界面提示「网络连接超时，请检查网络」？
一般是配置了无法访问外网的代理服务器所导致的，请将 IDEA 配置为「无代理」。
隐私与安全声明
Apifox Helper 插件仅在用户本机执行对于 Java 、Kotlin 源代码的识别工作。Apifox 重视您的数据资产安全，您的 Java 、Kotlin 源代码永远不会被上传至 Apifox 服务器。联系我们
Apifox Helper 插件中所遇到的任何问题或建议反馈，请添加下方微信（备注：IDEA），加入用户群沟通交流。修改于 2025-02-12 02:38:29