最新Spring Boot2 系列教程(十七)SpringBoot 整合 Swagger2，【干货

面试结束复盘查漏补缺

每次面试都是检验自己知识与技术实力的一次机会，面试结束后建议大家及时总结复盘，查漏补缺，然后有针对性地进行学习，既能提高下一场面试的成功概率，还能增加自己的技术知识栈储备，可谓是一举两得。

以下最新总结的阿里P6资深Java必考题范围和答案，包含最全MySQL、Redis、Java并发编程等等面试题和答案，用于参考~

重要的事说三遍，关注+关注+关注！

更多笔记分享

本文已被CODING开源项目：【一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码】收录

需要这份系统化的资料的朋友，可以点击这里获取

.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 查询用户的接口：

当然，除了这些之外，还有一些响应值的注解，都比较简单，小伙伴可以自己摸索下。

写在最后

还有一份JAVA核心知识点整理（PDF）：JVM，JAVA集合，JAVA多线程并发，JAVA基础，Spring原理，微服务，Netty与RPC，网络，日志，Zookeeper，Kafka，RabbitMQ，Hbase，MongoDB，Cassandra，设计模式，负载均衡，数据库，一致性哈希，JAVA算法，数据结构，加密算法，分布式缓存，Hadoop，Spark，Storm，YARN，机器学习，云计算…

本文已被CODING开源项目：【一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码】收录

需要这份系统化的资料的朋友，可以点击这里获取

281)]

本文已被CODING开源项目：【一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码】收录

需要这份系统化的资料的朋友，可以点击这里获取