Spring Boot集成Swagger2项目实战

以下是Spring Boot集成Swagger2项目实战的完整攻略：

1. 添加Swagger2依赖

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

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

2. 配置Swagger2

创建一个配置类，用于配置Swagger2：

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage(\"com.example.controller\"))
                .paths(PathSelectors.any())
                .build();
    }
}

3. 添加Swagger2注解

在Controller类或方法上添加Swagger2的注解，用于生成API文档。

示例1：在Controller类上添加注解

@RestController
@Api(tags = \"用户管理相关接口\")
public class UserController {

    @ApiOperation(\"获取用户列表\")
    @GetMapping(\"/users\")
    public List<User> getUsers() {
        // 返回用户列表
    }
}

在上述示例中，我们使用@Api注解为Controller类添加了一个标签，用于对API进行分类。使用@ApiOperation注解为方法添加了一个描述。

示例2：在方法参数上添加注解

@RestController
public class UserController {

    @ApiOperation(\"创建用户\")
    @PostMapping(\"/users\")
    public void createUser(@ApiParam(\"用户信息\") @RequestBody User user) {
        // 创建用户
    }
}

在上述示例中，我们使用@ApiParam注解为方法的参数添加了一个描述。

4. 访问Swagger2生成的API文档

启动项目后，可以通过访问以下URL来查看生成的Swagger2 API文档：

http://localhost:8080/swagger-ui/index.html

在Swagger2的UI界面中，您可以查看和测试API接口。

希望这个攻略对您有所帮助。如果您还有其他问题，请随时提问。

阅读剩余 42%