SpringBoot 整合 Swagger2

工程建立

固然，首先是建立一个 Spring Boot 项目，加入 web 依赖，建立成功后，加入两个 Swagger2 相关的依赖，完整的依赖以下：

<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> 复制代码

Swagger2 配置

Swagger2 的配置也是比较容易的，在项目建立成功以后，只须要开发者本身提供一个 Docket 的 Bean 便可，以下：

@Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .pathMapping("/") .select() .apis(RequestHandlerSelectors.basePackage("org.javaboy.controller")) .paths(PathSelectors.any()) .build().apiInfo(new ApiInfoBuilder() .title("SpringBoot整合Swagger") .description("SpringBoot整合Swagger，详细信息......") .version("9.0") .contact(new Contact("啊啊啊啊","blog.csdn.net","aaa@gmail.com")) .license("The Apache License") .licenseUrl("http://www.javaboy.org") .build()); } } 复制代码

这里提供一个配置类，首先经过 @EnableSwagger2 注解启用 Swagger2 ，而后配置一个 Docket Bean，这个 Bean 中，配置映射路径和要扫描的接口的位置，在 apiInfo 中，主要配置一下 Swagger2 文档网站的信息，例如网站的 title，网站的描述，联系人的信息，使用的协议等等。

如此，Swagger2 就算配置成功了，很是方便。

此时启动项目，输入 http://localhost:8080/swagger-ui.html，可以看到以下页面，说明已经配置成功了：

 

 

建立接口

接下来就是建立接口了，Swagger2 相关的注解其实并很少，并且很容易懂，下面我来分别向小伙伴们举例说明：

@RestController @Api(tags = "用户管理相关接口") @RequestMapping("/user") public class UserController { @PostMapping("/") @ApiOperation("添加用户的接口") @ApiImplicitParams({ @ApiImplicitParam(name = "username", value = "用户名", defaultValue = "李四"), @ApiImplicitParam(name = "address", value = "用户地址", defaultValue = "深圳", required = true) }) public RespBean addUser(String username, @RequestParam(required = true) String address) { return new RespBean(); } @GetMapping("/") @ApiOperation("根据id查询用户的接口") @ApiImplicitParam(name = "id", value = "用户id", defaultValue = "99", required = true) public User getUserById(@PathVariable Integer id) { User user = new User(); user.setId(id); return user; } @PutMapping("/{id}") @ApiOperation("根据id更新用户的接口") public User updateUserById(@RequestBody User user) { return user; } } 复制代码

这里边涉及到多个 API，我来向小伙伴们分别说明：

1. @Api 注解能够用来标记当前 Controller 的功能。
2. @ApiOperation 注解用来标记一个方法的做用。
3. @ApiImplicitParam 注解用来描述一个参数，能够配置参数的中文含义，也能够给参数设置默认值，这样在接口测试的时候能够避免手动输入。
4. 若是有多个参数，则须要使用多个 @ApiImplicitParam 注解来描述，多个 @ApiImplicitParam 注解须要放在一个 @ApiImplicitParams 注解中。
5. 须要注意的是，@ApiImplicitParam 注解中虽然能够指定参数是必填的，可是却不能代替 @RequestParam(required = true) ，前者的必填只是在 Swagger2 框架内必填，抛弃了 Swagger2 ，这个限制就没用了，因此假如开发者须要指定一个参数必填， @RequestParam(required = true) 注解仍是不能省略。
6. 若是参数是一个对象（例如上文的更新接口），对于参数的描述也能够放在实体类中。例以下面一段代码：

@ApiModel public class User { @ApiModelProperty(value = "用户id") private Integer id; @ApiModelProperty(value = "用户名") private String username; @ApiModelProperty(value = "用户地址") private String address; //getter/setter } 复制代码

好了，通过如上配置以后，接下来，刷新刚刚打开的页面，能够看到以下效果：

 

 

能够看到，全部的接口这里都列出来了，包括接口请求方式，接口地址以及接口的名字等，点开一个接口，能够看到以下信息：

 

 

能够看到，接口的参数，参数要求，参数默认值等等通通都展现出来了，参数类型下的 query 表示参数以 key/value 的形式传递，点击右上角的 Try it out，就能够进行接口测试：

 

 

点击 Execute 按钮，表示发送请求进行测试。测试结果会展现在下面的 Response 中。

小伙伴们注意，参数类型下面的 query 表示参数以 key/value 的形式传递，这里的值也多是 body，body 表示参数以请求体的方式传递，例如上文的更新接口，以下：

 

 

固然还有一种可能就是这里的参数为 path，表示参数放在路径中传递，例如根据 id 查询用户的接口：

 

 

固然，除了这些以外，还有一些响应值的注解，都比较简单，小伙伴能够本身摸索下。

在 Security 中的配置

若是咱们的 Spring Boot 项目中集成了 Spring Security，那么若是不作额外配置，Swagger2 文档可能会被拦截，此时只须要在 Spring Security 的配置类中重写 configure 方法，添加以下过滤便可：

@Override
public void configure(WebSecurity web) throws Exception {
    web.ignoring()
            .antMatchers("/swagger-ui.html") .antMatchers("/v2/**") .antMatchers("/swagger-resources/**"); } 复制代码

如此以后，Swagger2 文件就不须要认证就能访问了。不知道小伙伴们有没有看懂呢？有问题欢迎留言讨论。 关注公众号【江南一点雨】，专一于 Spring Boot+微服务以及先后端分离等全栈技术，按期视频教程分享，关注后回复 Java ，领取松哥为你精心准备的 Java 干货！

做者：江南一点雨
连接：https://juejin.im/post/5db78ef1f265da4d3e173a6e