Swagger 是一款 RESTful 接口的文档在线自动生成+功能测试功能软件,本文将会介绍这款工具并在 Spring Boot 项目中集成 Swagger。
我们的新蜂商城 Vue 版本开发过程就一直在用 Swagger 这个工具,主要用来 生成接口文档以及进行接口测试工作,大家在运行源码后也可以通过 swagger-ui 页面看到新蜂商城的所有 API 文档,如下图所示:
本文主要知识点如下:
- 认识 Swagger
- Spring Boot 集成 Swagger
- Swagger 接口测试
什么是 Swagger
Swagger 为开发者提供了一套规范去定义接口和接口相关的信息,通过 springfox-swagger 依赖 jar 包可以将基于 Spring MVC 和 Spring Boot 项目的项目代码,自动生成 JSON 格式的描述文件,我们可以通过这套接口描述数据生成各种接口文档。
目前有很大一部分 Spring Boot 的开发者会将其用来构建 RESTful API,而我们构建RESTful API的目的通常都是由于多终端的原因,这些终端会共用很多底层业务逻辑,因此我们会抽象出这样一层来同时服务于多个移动端或者Web前端。这样一来,我们的RESTful API就有可能要面对多个开发人员或多个开发团队:iOS 开发、Android 开