Apifox自动生成接口文档

1、安装

1.1 Apifox安装

官方文档：Apifox - API 文档、调试、Mock、测试一体化协作平台 - 接口文档工具，接口自动化测试工具，接口Mock工具，API文档工具，API Mock工具，API自动化测试工具

1.2 IDEA 插件安装

    打开 IDEA > Preferences(Settings) > Plugins ，搜索 Apifox Helper

2、Apifox配置

2.1 创建团队

2.2 创建项目

3、idea配置

官方地址：Apifox IDEA 插件快速上手 | Apifox 帮助文档

3.1 获取项目 ID

打开项目设置——基本设置，复制项目 ID

3.2 获取访问令牌

Apifox 个人访问令牌：获取访问令牌

复制令牌

3.3 idea配置

    安装插件后，进入设置界面 Preferences(Settings) >Other Setting> ApifoxHelper

• Apifox 服务器地址: 填写 Apifox API 服务地址，SaaS 版默认为 https://api.apifox.cn
• Apifox 个人访问令牌：获取可参考文档获取访问令牌
• 模块项目 ID 配置: 代码模块名和项目 ID 的映射关系配置，其中项目 ID 的获取可参考文档获取项目 ID

框架配置

    针对特定框架，

Apifox

插件支持选择远程配置和添加自定义的远程配置 URL。

3.5 同步接口到 Apifox

3.5.1 同步模块内所有接口

在模块目录上的右键菜单中选择

Upload to Apifox

再次输入项目id

apifox中刷新，就可以看到生成的接口了。

3.5.2 同步 controller 文件内所有接口

    在代码编辑区域的**右键菜单**中选择 

Upload to Apifox

3.5.3 同步选择部分接口

• 在模块目录上或代码编辑区域的右键菜单中选择 Export API
• 选择想要同步的单个或部分接口，回车执行同步请求

4、分享

查看链接地址

5、接口配置

5.1 官方文档

官方文档：常见问题 FAQ | Apifox 帮助文档

注释规范：注释规范说明 | Apifox 帮助文档

5.2 示例

• 第一行为标题
• 第二行为描述