swagger2生成api接口文档

Swagger是一款流行的API设计工具，它可以帮助我们更轻松地设计、构建和测试API。Swagger2是Swagger的一个版本，它可以生成API接口文档，这样我们就可以更清晰地了解API的使用方法。

下面是使用Swagger2生成API接口文档的步骤：

1. 在项目中添加Swagger2依赖

在Maven项目中，可以在pom.xml文件中添加以下依赖：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

2. 配置Swagger2

在Spring Boot项目中，可以在application.properties或application.yml文件中添加以下配置：

# Swagger2配置
swagger2.enabled=true # 启用Swagger2
swagger2.title=API接口文档 # 文档标题
swagger2.description=API接口文档 # 文档描述
swagger2.version=1.0 # 文档版本
swagger2.basePackage=com.example.demo # 扫描的包路径

3. 编写API接口

在Spring Boot项目中，可以使用Spring MVC的注解来编写API接口，例如：

@RestController
@RequestMapping("/api")
@Api(tags = "用户管理")
public class UserController {

    @GetMapping("/users")
    @ApiOperation("获取用户列表")
    public List<User> getUsers() {
        // TODO: 查询用户列表
        return null;
    }

    @GetMapping("/users/{id}")
    @ApiOperation("根据ID获取用户")
    @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")
    public User getUserById(@PathVariable Long id) {
        // TODO: 根据ID查询用户
        return null;
    }

    @PostMapping("/users")
    @ApiOperation("创建用户")
    @ApiImplicitParam(name = "user", value = "用户信息", required = true, dataType = "User")
    public User createUser(@RequestBody User user) {
        // TODO: 创建用户
        return null;
    }

    @PutMapping("/users/{id}")
    @ApiOperation("更新用户")
    @ApiImplicitParams({
        @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long"),
        @ApiImplicitParam(name = "user", value = "用户信息", required = true, dataType = "User")
    })
    public User updateUser(@PathVariable Long id, @RequestBody User user) {
        // TODO: 更新用户
        return null;
    }

    @DeleteMapping("/users/{id}")
    @ApiOperation("删除用户")
    @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")
    public void deleteUser(@PathVariable Long id) {
        // TODO: 删除用户
    }
}

4. 访问Swagger2文档

在启动Spring Boot应用程序后，可以在浏览器中访问以下URL以查看Swagger2生成的API接口文档：http://localhost:8080/swagger-ui.html

在Swagger2的文档页面中，可以查看接口的详细信息，包括请求和响应的参数、请求方式、请求路径等。同时，我们也可以在页面中测试API接口。