SpringBoot集成Swagger：快速生成API文档

Swagger是一个强大的工具，可以帮助你快速生成RESTful API文档，并提供在线测试的功能，方便前后端开发协作。以下步骤将详细介绍如何在SpringBoot项目中配置并使用Swagger:

1. 添加Swagger依赖

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

<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>

2. 创建Swagger配置类

创建一个配置类，例如Swagger2Config.java，并在其中配置Swagger：

@Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage('com.example.demo.controller'))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title('Spring Boot中使用Swagger2构建RESTful APIs')
                .description('更多Spring Boot相关文章请关注：https://www.baidu.com/')
                .termsOfServiceUrl('https://www.baidu.com/')
                .contact('作者')
                .version('1.0')
                .build();
    }
}

3. 在Controller中使用注解

在Controller类中添加Swagger注解，例如：

@RestController
@Api(tags = '用户管理')
@RequestMapping('/user')
public class UserController {
    @ApiOperation(value = '获取用户列表', notes = '获取用户列表')
    @RequestMapping(value = '/list', method = RequestMethod.GET)
    public List<User> getUserList() {
        return null;
    }

    @ApiOperation(value = '创建用户', notes = '根据User对象创建用户')
    @ApiImplicitParam(name = 'user', value = '用户详细实体user', required = true, dataType = 'User')
    @RequestMapping(value = '/', method = RequestMethod.POST)
    public String postUser(@RequestBody User user) {
        return 'success';
    }

    @ApiOperation(value = '获取用户详细信息', notes = '根据url的id来获取用户详细信息')
    @ApiImplicitParam(name = 'id', value = '用户ID', required = true, dataType = 'Long')
    @RequestMapping(value = '/{id}', method = RequestMethod.GET)
    public User getUser(@PathVariable Long id) {
        return null;
    }

    @ApiOperation(value = '更新用户详细信息', notes = '根据url的id来指定更新对象，并根据传过来的user信息来更新用户详细信息')
    @ApiImplicitParams({
            @ApiImplicitParam(name = 'id', value = '用户ID', required = true, dataType = 'Long'),
            @ApiImplicitParam(name = 'user', value = '用户详细实体user', required = true, dataType = 'User')
    })
    @RequestMapping(value = '/{id}', method = RequestMethod.PUT)
    public String putUser(@PathVariable Long id, @RequestBody User user) {
        return 'success';
    }

    @ApiOperation(value = '删除用户', notes = '根据url的id来指定删除对象')
    @ApiImplicitParam(name = 'id', value = '用户ID', required = true, dataType = 'Long')
    @RequestMapping(value = '/{id}', method = RequestMethod.DELETE)
    public String deleteUser(@PathVariable Long id) {
        return 'success';
    }
}

4. 启动应用，访问swagger-ui.html

启动你的SpringBoot应用，然后访问 http://localhost:8080/swagger-ui.html 即可查看生成的API文档，并在线测试API。

以上就是在Spring Boot中配置并使用Swagger的步骤，希望能帮助你快速生成API文档，提高开发效率。