03-Apifox接口文档一体化协作平台

一、接口文档选型

默认的原生的 swagger 界面和交互并不是很便捷，增加了前后端沟通和协作的时间成本。

因此选择成型的免费、功能丰富、没有太多限制的工具 ApiFox (很多大厂都在用)，强烈推荐！

Apifox 官方网站地址：Apifox - API 文档、调试、Mock、测试一体化协作平台。

Apifox 官方帮助文档：Apifox 快速入门 | Apifox 帮助文档

● 推荐官网首页直接下载客户端版（免费）使用即可。

二、代码改动

2.0 pom依赖新增

<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-annotations</artifactId>
    <version>1.5.22</version>
</dependency>

2.1 Swagger 注解补全

以下为示例。

@Api - 接口类

@ApiOperation - 接口方法

@ApiParam - 方法参数

@ApiModel - 实体参数

@ApiModelProperty - 实体参数字段

2.2 Controller 返回值统一

返回List

返回分页

返回对象

返回其他类型

三、Apifox一键导入

3.1 新建团队

3.2 新建项目

团队下新建项目。

3.3 导入数据

3.4 效果使用

入参显示

出参显示

自测调用

四、协作流程

4.1 分享接口文档

4.2 查看接口文档

示例链接：

https://apifox.com/apidoc/shared-6bbcd6f0-70f4-4478-bf6b-2a71ca976a22/api-189590149

五、其他补充

● 分享链接注意不要外泄

● 分享链接地址中注意禁止选择生产环境请求地址（防止接口盗刷带来的风险）