Spring Boot整合Swagger2

swagger2 是一个规范和完整的框架，用于生成、描述、调用和可视化Restful风格的web服务。

作用：

1、接口的文档在线自动生成

2、功能测试

Spring Boot整合Swagger2

1.添加Swagger相关依赖

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

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.swagger.controller"))
                .paths(PathSelectors.any())
                .build().apiInfo(new ApiInfoBuilder()
                        .description("接口文档描述信息")
                        .title("xx项目接口文档")
                        .contact(new Contact("zby","http://www.baidu.com","578499116@qq.com"))
                        .version("v1.0")
                        .license("Apache2.0")
                        .build());

    }
}

写好测试类和测试接口后启动项目，访问localhost:8080/swagger-ui.html即可看到接口文档信息

image

也可以在该页面进行接口测试。

可以在接口中利用swagger2提供的注解对接口及接口中的方法进行描述

@Api(tags = "xxx"):对接口功能进行描述

@ApiOperation(value = "xxx",notes = "xxx"):对接口中方法的描述

@ApiImplicitParam(name = "xxx",value = "xxx" ):对参数进行描述