ApifoxHelper downloads statistics

Apifox Helper

Apifox Helper is a plugin launched by Apifox for the IntelliJ IDEA. It can parse the source code of Java or Kotlin projects, automatically generate API documentations and sync them to Apifox projects.

帮助文档

Apifox Helper 是 Apifox 团队针对 IntelliJ IDEA 所推出的插件，可以在 IDE 中识别本地 Java、Kotlin 后端项目的源代码，直接在 IDE 侧边栏调试接口，自动生成 API 文档并同步到 Apifox 的项目中。

对于常见的开发框架，Apifox Helper 插件能够做到开箱即用，实现真正的代码零侵入。仅通过识别最基本的业务代码，即可生成一份详尽的 API 文档。

功能特性

• 自动生成 API 文档并一键同步到 Apifox 的项目中 • 直接在 IDE 侧边栏调试接口，自动填写请求参数和 URL • 导出 OpenAPI 文件

支持的框架和库

类型名称注解示例

服务端框架Spring, Quarkus, Jakarta RESTful Web Services (JAX-RS)@RestController, @GetMapping, @Path, @Get

校验库Jakarta Bean Validation, Java Bean Validation@NotNull

序列化库FASTJSON, Jackson, GSON@JSONField, @JsonProperty, @SerializedName

API 规格库Swagger 2.x, Swagger/OpenAPI 3.x@ApiOperation, @ApiParam, @Operation, @Parameter

持久化框架MyBatis

客户端库Spring Cloud OpenFeign

性能指标库Spring Boot Actuator

语言与注释Java: Javadoc, Kotlin: KDoc

本插件基于 easy-api 定制开发，感谢 easy-api 作者。