在开发过程中，API文档的编写和维护是一个必不可少的工作。Swagger是一个非常流行的API文档生成工具，它可以帮助开发人员自动生成和管理API文档。而SpringBoot是一种快速开发框架，可以帮助我们快速搭建Java Web应用。本文将介绍如何在SpringBoot项目中集成Bootstrap-Swagger-ui（现在称为knife4j），这是一个在Swagger基础上进行扩展的工具，提供了更强大的功能和更丰富的界面。
1. 引入依赖
首先，在pom.xml文件中引入knife4j的依赖：
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>2.0.2</version>
</dependency>
2. 配置Swagger
在SpringBoot的配置文件中，配置Swagger相关的信息，如下所示：
# swagger配置
## 是否启用swagger，默认为true
knife4j.enable=true
## 设置api文档的标题
knife4j.title=SpringBoot API文档
## 设置api文档的描述
knife4j.description=这是一个用于展示SpringBoot集成Swagger的API文档
## 设置api文档的版本
knife4j.version=1.0.0
## 设置api文档的联系人信息
knife4j.contact.name=John Doe
knife4j.contact.url=https://example.com
knife4j.contact.email=johndoe@example.com
3. 编写API文档
在SpringBoot的控制器类中通过注解来编写API文档，如下所示：
@RestController
@RequestMapping("/api")
@Api(tags = "用户管理相关接口")
public class UserController {
@GetMapping("/users")
@ApiOperation(value = "获取用户列表")
public List<User> getUsers() {
// ...
}
@PostMapping("/users")
@ApiOperation(value = "创建用户")
public User createUser(@RequestBody User user) {
// ...
}
@PutMapping("/users/{id}")
@ApiOperation(value = "更新用户信息")
public User updateUser(@PathVariable Long id, @RequestBody User user) {
// ...
}
@DeleteMapping("/users/{id}")
@ApiOperation(value = "删除用户")
public void deleteUser(@PathVariable Long id) {
// ...
}
}
4. 查看API文档
启动SpringBoot应用，并访问http://localhost:8080/doc.html，就可以看到生成的API文档了。 knife4j提供了一个非常漂亮且功能丰富的界面，可以方便地查看和测试接口。
5. 扩展功能
除了基本的API文档生成功能之外，knife4j还提供了一些其他的扩展功能：
- 数据模拟器：在API文档中可以配置响应数据的模板，方便测试和演示。
- 鉴权功能：支持通过接口鉴权，保护API的访问安全。
- 在线API测试：可以直接在API文档中进行接口测试，省去了使用其他工具的麻烦。
综上所述，SpringBoot集成Bootstrap-Swagger-ui（现在叫knife4j）能够为我们的API文档编写和管理工作提供很大的便利。它不仅提供了强大的功能，而且还有一个漂亮的界面，让我们能够更清晰地了解和测试接口。如果你正在开发一个SpringBoot项目，并且需要编写API文档，不妨尝试一下knife4j吧。
希望本文对你有所帮助，如果有任何问题，请随时留言。感谢阅读！
本文来自极简博客，作者：码农日志，转载请注明原文链接：SpringBoot集成Bootstrap-Swagger-ui，现在叫knife4j，功能更强大
