IntelliJ IDEA 集成 ApiFox 操作与注解规范指南本文介绍了IntelliJ IDEA集成Apifox的

一、IDEA装入Apifox

说明：在 IntelliJ IDEA 中安装 ApiFox Helper 插件。

编辑

说明：点击设置，在菜单中选择 API访问令牌。在弹出的窗口中输入任意名称，并选择令牌的有效期（为了方便，我这里选择了无期限）。生成令牌后，由于令牌只能复制一次，请务必妥善保存。

编辑

说明：点击 ApiFox Helper，选择上传到 ApiFox，将刚才复制的 API 访问令牌粘贴进去，然后点击测试令牌。如果测试成功，右侧会显示成功提示消息。

编辑

说明：点击加号图标，选择对应的 ApiFox 项目，在右侧框中选择相应的模块和分支，然后点击确定即可完成配置。

编辑

说明：ApiFox 兼容 Spring Boot 注解生成接口文档。对 OpenAPI 3 / springdoc 注解支持比较好。

说明：@Api(tags = "常规数据获取") 对应 ApiFox 中的目录/文件夹名称，而 @ApiOperation("查询数据") 对应 ApiFox 中的接口文件。

编辑

说明：生成接口文档时给字段添加说明。value：字段描述（等同于你写的 "主键ID"），example：给一个示例值，required：是否必填，hidden：是否在文档中隐藏。

例：

@ApiModelProperty(value = "主键ID", example = "123", required = true)
private Long id;

编辑

说明：listDataFetch 是一个公有方法，它返回一个 Result 对象，里面包含一个 DataFetch 对象的列表，用于统一封装接口或服务返回的数据，同时可以携带状态码、提示信息等。

编辑

说明：@NotNull 用于校验对象是否为 null，适用于任意类型；@NotBlank 用于校验字符串不为 null、长度大于 0 且不全为空格，只能用于字符串；@Schema 是 OpenAPI 3 的注解，用于给接口文档中的字段添加描述和示例值，使生成的文档更清晰可读。

编辑

说明：生成的apifox请求参数查看。

编辑

说明：上传后，ApiFox 会根据你的注解生成项目目录、接口文件、接口文档。需要先提供 API访问令牌来验证身份和权限。上传功能可以让本地代码和在线文档保持一致和实时更新，方便团队协作。简单说就是：把本地接口代码及注解自动生成的文档，同步到 ApiFox 平台管理和展示。

编辑

说明：IDEA 下方的控制台窗口会显示上传状态、成功或失败的详细信息。

编辑

说明：根据本地代码中的注解和配置，自动生成 ApiFox 项目的接口目录和结构，包括接口分组、接口文件、请求参数、返回示例等，从而无需手动创建或维护接口文档，提升开发效率并保证文档与代码的一致性。