webjars 一篇文章带你搞懂 Swagger 与 SpringBoot 整合

Swagger 使用

Swagger 有什么用？

Swagger 是一个流行的API开发框架，这个框架以“开放API声明” （OpenAPI Specification，OAS） 为基础，

对整个 API 的开发周期都提供了相应的解决方案，是一个非常庞大的项目（包括设计、编码和测试，几乎支持所有语言）。

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

总体目标是使客户端和文件系统作为服务器以同样的速度来更新。

文件的方法，参数和模型紧密集成到服务器端的代码，允许 API 来始终保持同步。 Swagger 让部署管理和使用功能强大的 API 从未如此简单。

SpringBoot 与 Swagger2

由于 JAVA 的强大的注解功能，我们使用 SpringBoot 来结合 Swagger2 ，在使用起来非常简单.

第一步：新建 SpringBoot 项目，引入依赖.

io.springfox springfox-swagger2 2.7.0 io.springfox springfox-swagger-ui 2.7.0

上面两个依赖的作用：

springfox-swagger2 依然是依赖 OSA 规范文档，也就是一个描述 API 的 json 文件，而这个组件的功能就是帮助我们自动生成这个 json 文件

springfox-swagger-ui 就是将这个 json 文件解析出来，用一种更友好的方式呈现出来。

第二步：创建 API

@RestControllerpublic class UserController { @RequestMApping("/hello",method = RequestMethod.GET) public String hello(){ return "hello"; }}

配置 Swagger2

现在 Swagger2 还不能为我们生成 API 文档，因为我们还没有对它进行配置。

我们需要创建一个配置类，进行如下配置：

@Configuration@EnableSwagger2public class SwaggerConfig{ @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.itguang.springbootswaggerdemo1.web")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Spring Boot中使用Swagger2构建RESTful API") .description("rest api 文档构建利器") .termsOfServiceUrl("http://blog.csdn.net/itguangit") .contact("itguang") .version("1.0") .build(); }}

springfox 为我们提供了一个 Docket（摘要的意思）类，我们需要把它做成一个 Bean 注入到 spring 中。显然，我们需要一个配置文件，并通过一种方式（显然它会是一个注解）告诉程序，这是一个 Swagger 配置文件。

springfox 允许我们将信息组合成一个 ApiInfo 的类，作为构造参数传给 Docket（当然也可以不构造这个类，而直接使用 Null，但是你的这个 API 就太 low 了）。

搞定

现在我们要做的配置已经能满足一个生成 API 文档的基本要求了，让我们启动项目，访问 http://localhost/swagger-ui.html

会看到如下界面:

这是 Swagger-ui 为我们生成的界面.

Swagger2 注解使用

接下来我们就要好好研究下 springfox-swagger2 给我们提供的注解了.

我们新建一个 Controller，用来对 User 类进行增删改查常用操作。

@RestController@RequestMapping(value = "/user", produces = APPLICATION_JSON_VALUE) //配置返回值 application/json@Api(description = "用户管理")public class HelloController { ArrayList users = new ArrayList<>(); @ApiOperation(value = "获取用户列表", notes = "获取所有用户信息") @RequestMapping(value = {""}, method = RequestMethod.GET) public List hello() { users.add(new User("逻辑", "luoji")); users.add(new User("叶文杰", "yewenjie")); return users; }}

可以看到我们在 Controller 上使用了 @Api(description = "用户管理") 注解，在方法上使用了 @ApiOperation(value = "获取用户列表", notes = "获取所有用户信息") 注解。

这会产生什么样的效果呢? 我们可以再次访问下试试看：

可以看到我们红框裱起来的地方发生了改变，并且神奇的是它还自动判断出了我们的返回类型：

[ { "age": 0, "email": "string", "enabled": true, "id": "string", "password": "string", "username": "string" }]

但是我们如果想选择性的忽略某个字段，而不是把 User 类中的所有字段暴露出去呢?别着急，我们可以使用另一个注解：@ApiModelProperty(hidden = true)。此注解可以作用在字段或者方法上，只要 hidden 属性为 true ，该字段或者方法就不会被生成 API 文档。

@Datapublic class User { private String id; private String username; @ApiModelProperty(hidden = true) private String password; private String email; private Integer age; private Boolean enabled;}

我们有意忽略了 password 字段，再次刷新浏览器，会看到：

确实 password 字段不见了。

接下来我们在模拟一个创建用户的 API：

@ApiOperation(value = "创建用户", notes = "根据User对象创建用户") @RequestMapping(value = "/create", method = RequestMethod.POST) public User postUser(User user) { return user; }

可以看到我们需要客户端传给我们一个 User 对象，用来创建和该用户，这里我们什么也不做，只是把接受到的 User 对象返回给客户端，来表示创建成功。

我们刷新浏览器看下：

可以看到请求参数并不是让我们很满意啊，第一没有字段说明，第一有些字段在创建用户时我们并不需要啊，还是不要着急，我们也有办法解决：

@ApiModelProperty(hidden = true) private String id; @ApiModelProperty(value = "用户名") private String username; @ApiModelProperty(value = "密码") private String password; @ApiModelProperty(value = "邮箱") private String email; @ApiModelProperty(hidden = true) private Integer age; @ApiModelProperty(hidden = true) private Boolean enabled;

我们在User对象的字段上添加 上面的注解： @ApiModelProperty(hidden = true) 和 @ApiModelProperty(value = "用户名")。

value 属性指明了该字段的含义(描述 Description)，再次刷新浏览器试试：

怎么样，是不是很简单。

下面我们看看如何传递参数。添加一个方法，根据 id 获取用户信息：

@ApiOperation(value = "获取用户详细信息", notes = "根据url的id来获取用户详细信息") @RequestMapping(value = "getUser/{id}", method = RequestMethod.GET) public User getUser(@PathVariable(value = "id") String id) { return new User(id, "itguang", "123456"); }

刷新浏览器，可以看到：

我们需要客户端传入一个参数 id，现在我们要给 id 这个参数一个说明(Description)，该咋办呢? 还是不要着急，很简单像下面这样即可：

@ApiOperation(value = "获取用户详细信息", notes = "根据url的id来获取用户详细信息") @RequestMapping(value = "getUser/{id}", method = RequestMethod.GET) public User getUser(@ApiParam(value = "用户id", required = true) //[注意] @ApiParam与 Controller中方法并列使用,也可以省略的 @PathVariable(value = "id") String id) { return new User(id, "itguang", "123456"); }

我们添加了 @ApiParam(value = "用户id", required = true) 这个注解，需要注意的是，这个注解方法的参数前面，不能直接用在方法上面。

再次刷新浏览器：

常用注解说明：

通过上面的了解，我们大概已经会使用 Swagger2 了，但我们只介绍了一些简单常用的注解。

下面我们系统的总结一下：

Swagger2 基本使用(重点加粗显示)：

@Api：描述类/接口的主要用途

@ApiOperation：描述方法用途

@ApiImplicitParam：描述方法的参数

@ApiImplicitParams：描述方法的参数(Multi-Params)

@ApiParam：请求属性

@ApiIgnore：忽略某类/方法/参数的文档

@ApiResponse：响应配置

@ApiResponses：响应集配置

@ResponseHeader：响应头设置

@ApiModel：标识请求/相应模型

@ApiModelProperty：添加和操作模型属性的数据

我想看中文的

经过上面的介绍，你应该已经会使用 Swagger2 了。但是对于有些人来说，看上面的英文表示很难受，有没有中文的?

有!

根据官方文档上的提示，在 SpringBoot 下更换界面和语言还是很简单的，首先我们需要对 SpringBoot 的资源目录有个了解：

Spring Boot 默认“约定”从资源目录的这些子目录读取静态资源：

src/main/resources/META-INF/resources src/main/resources/static （推荐） src/main/resources/public

举个栗子：现在static目录下有一张图片，kumamon.jpg，访问地址是 http://localhost:8080/img/kumamon.jpg

注：若不同静态目录含有相同路径图片，则按上述优先级，即 META-INF/resources 目录优先级最高。

了解了 SpringBoot 的资源目录的优先级，我们来看看之前引入的 springfox-swagger-ui 这个包，打开 Maven 依赖找到它：

展开如下所示：

还记得我们之前为什么浏览器输入 http://localhost/swagger-ui.html 就会看到一个 Swagger 的页面吗，没错就是这里啦。其中 swagger-ui.html 就是首页。

打开看下：