spring boot2集成swagger2自动生成API接口文档

步骤一：导入依赖，注意SWAGGER和UI最好保持版本一致，否则可能会遇到不同的坑

    io.springfox
    springfox-swagger-ui
    2.9.2




    io.springfox
    springfox-swagger2
    2.9.2

步骤二：在spring boot2中启用swagger2，（注意看我swagger2中如何匹配多个controller的正确写法）

/**
 * 湖北金鹏信息技术有限公司 版权所有 © Copyright 2018

 *
 * @Description: 

 * @Project: hades 

 * @CreateDate: Created in 2019/4/3 16:24 

 * @Author: xiaozm
 */
@Configuration
@EnableSwagger2
public class SwaggerConf {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 自行修改为自己的包路径
                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("深度应用后台api接口文档")
                .description("restful 风格接口")
                .version("1.0")
                .build();
    }

}

步骤三：在controller中给接口写注解。

@Api：修饰整个类，描述Controller的作用 

@ApiOperation：描述一个类的一个方法，或者说一个接口 

value="说明方法的用途、作用"
    notes="方法的备注说明"

@ApiResponses：用在请求的方法上，表示一组响应
    @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
        code：数字，例如400
        message：信息，例如"请求参数没填好"
        response：抛出异常的类

@ApiImplicitParams：用在请求的方法上，表示一组参数说明
 @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
        name：参数名
        value：参数的汉字说明、解释
        required：参数是否必须传
        paramType：参数放在哪个地方
            · header --> 请求参数的获取：@RequestHeader
            · query --> 请求参数的获取：@RequestParam
            · path（用于restful接口）--> 请求参数的获取：@PathVariable
            · body（不常用）
            · form（不常用）    
        dataType：参数类型，默认String，其它值dataType="Integer"       
        defaultValue：参数的默认值

@ApiParam：单个参数描述 
@ApiModel：用对象来接收参数 
@ApiProperty：用对象接收参数时，描述对象的一个字段 

@ApiIgnore：使用该注解忽略这个API 
@ApiError ：发生错误返回的信息