swagger2 java配置

Swagger2是一个用于生成API文档的工具，可以方便地展示Web服务的接口文档，下面是Swagger2在Java项目中的配置步骤：

1. 引入Swagger2依赖

在项目的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. 配置Swagger2

在Spring Boot项目的启动类或者@Configuration配置类中，添加以下配置：

@Configuration
@EnableSwagger2 // 开启Swagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller")) // 扫描指定包下的Controller
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("XXX项目API文档")
                .description("XXX项目的API文档")
                .version("1.0")
                .build();
    }
}

其中，Docket是Swagger2的配置类，apiInfo()方法用于配置API文档信息，createRestApi()方法用于指定扫描的Controller所在的包路径。

3. 添加API文档注解

在需要生成API文档的Controller方法上，添加相应的注解，例如：

@RestController
@RequestMapping("/user")
@Api(tags = "用户管理相关接口")
public class UserController {
    @ApiOperation("获取用户列表")
    @GetMapping("/list")
    public List<User> list() {
        // ...
    }

    @ApiOperation("添加用户")
    @PostMapping("/add")
    public void add(@RequestBody User user) {
        // ...
    }
}

其中，@Api注解用于指定接口所属的标签，@ApiOperation注解用于指定接口的描述信息。

4. 查看API文档

在项目启动后，访问http://localhost:port/swagger-ui.html即可查看API文档。在文档页面中，可以查看接口的详细信息、请求参数、响应信息等。