摆脱接口文档：springboot整合swagger2

首先接入swagger的mvn依赖

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

当然还有是个web开发者都知道引入springbootweb依赖

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

依赖引入完成后我们就需要配置swagger了，让spring来管理swagge@Configurat@EnableSwagger2

public class SwaggerConfig {

    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .pathMapping("/")
                .select()

                .apis(RequestHandlerSelectors.basePackage("com.xw.suguo.controller"))
                .paths(PathSelectors.any())
//                .paths(PathSelectors.ant("/film/dgFilm"))
                .build()
                .apiInfo(new ApiInfoBuilder()
                        .title("接口文档")
                        .description("接口文档描述")
                        .version("1.0")
                        .build());

    }
}

这里着重讲几个参数的使用：

RequestHandlerSelectors,配置要扫描接口的方式 （包含已下几种方式，具体实现需要开发者自己测试）

//basePackage：指定扫描的包路径

//any：扫描全部

//none：全部不扫描

//withClassAnnotation:扫描类上的注解，如RestController

//withMethodAnnotation:扫描方法上的注解，如GetMapping

 

PathSelectors 设置对应的请求路径 包含any(),ant("/...") 请注意ant方法里面的方式必须是全部的请求路径，如果只写一半识别不了

此时配置好之后就可已愉悦的写代码了
类上加@APi（tag=“类接口测试”）
方法上加@ApiOperation("方法接口测试")