告别Swagger3/Apifox/Postman
Swagger3（丝袜哥）
- 地址：REST API Documentation Tool | Swagger UI
- 简介：在java代码里面增加注解生成接口文档
RestController
@RequestMapping("api/v1/user")
@Api(tags = "用户模块",value = "用户UserController")
public class UserController {@Autowiredprivate BannerService bannerService;@ApiOperation("分页用户列表")@GetMapping("list")public JsonData list(){List<BannerDO> list = bannerService.list();return JsonData.buildSuccess(list);}
}
-
- 支持SpringMVC、SpringBoot、SpringCloud等主流java框架
- 对java代码友好
- 界面简洁
- 国内比较活跃,主要是spring社区带动
- 功能比较多
-
- 对跨语言支持不友好（可以和knife4j整合解决这个问题）
- 代码需要引入相关依赖包和配置
- 文档相对缺少
Apifox（智灵狐）
- 地址：Apifox - API 文档、调试、Mock、测试一体化协作平台。拥有接口文档管理、接口调试、Mock、自动化测试等功能，接口开发、测试、联调效率，提升 10 倍。最好用的接口文档管理工具，接口自动化测试工具。
- 简介：
-
- Apifox = Postman + Swagger + Mock + JMeter
- 设计、开发、测试一体化协作平台
PostMan（邮寄男人）
- 地址：Download Postman | Get Started for Free
- 简介：用来模拟各种HTTP请求的(如:get/post/delete/put…等等)，postman与浏览器的区别在于有的浏览器不能输出json格式，而postman可以更直观看到接口返回的结果。
试试IDEA自带的 Generate request in HTTP Client
工具使用：
官方模板：
写操作Post/Delete/Put：
###
POST http://localhost:24618/user/add
Accept: application/json
Content-Type: application/json{"username": "zhangsan","password": "123456","sex": "1"
}
读操作Get:
###
GET http://localhost:24618/user/{{id}}//将上述{{id}}换成一个真实的主键id即可
