<!--swagger依賴-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<!--swagger ui-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>

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

@Configuration
@EnableSwagger2  //開啟Swagger2
public class Swagger2Config {
    /**
     * 創(chuàng)建API應(yīng)用
     * apiInfo() 增加API相關(guān)信息
     * 通過select()函數(shù)返回一個(gè)ApiSelectorBuilder實(shí)例,用來控制哪些接口暴露給Swagger來展現(xiàn)，
     * 指定掃描的包路徑來定義指定要建立API的目錄。
     * @return
     */
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(adminApiInfo())
                 //.enable(false) //enable是否啟動(dòng)Swagger 如果為false，則swagger不能在瀏覽器中訪問
                .groupName("adminApi")
                .select()
                //RequestHandlerSelectors 配置要掃描接口的方式
                //basePackage: 指定要掃描的包
                //any()：掃描全部
                //none()不掃描
                //withClassAnnotation: 掃描類上的注解，參數(shù)為一個(gè)注解的反射對(duì)象
                //withMethodeAnnotation: 掃描方法上的注解
                .apis(RequestHandlerSelectors.basePackage("com.example.swagger.controller"))
                //只顯示admin下面的路徑
                .paths(Predicates.and(PathSelectors.regex("/admin/.*")))
                .build();
    }

    private ApiInfo adminApiInfo(){
        return new ApiInfoBuilder()
                .title("api文檔")
                .description("系統(tǒng)接口描述")
                .version("1.0")
                //作者信息
                .contact(new Contact("張三","http://baidu.com","12345678@qq.com"))
                .build();
    }
}

@ApiModel("用戶實(shí)體類")
public class User{

    @ApiModelProperty("用戶名")
    public String username;
}

@RestController
public class UserController{
    
    @ApiOperation("User控制類")
    @GetMapping(value="/user")
    public String getUser(@ApiParam("用戶名")String username){
    return "名字為："+username;
} 
}

@Api：修飾整個(gè)類，描述Controller的作用,放在類上

@ApiOperation：描述一個(gè)類的一個(gè)方法，或者說一個(gè)接口

@ApiParam：單個(gè)參數(shù)描述

@ApiModel：用對(duì)象來接收參數(shù)

@ApiProperty：用對(duì)象接收參數(shù)時(shí)，描述對(duì)象的一個(gè)字段

@ApiResponses：HTTP響應(yīng)整體描述

@ApiResponse：HTTP響應(yīng)其中1個(gè)描述

@ApiIgnore：使用該注解忽略這個(gè)API

@ApiError ：發(fā)生錯(cuò)誤返回的信息

@ApiImplicitParams：描述由多個(gè) @ApiImplicitParam 注解的參數(shù)組成的請(qǐng)求參數(shù)列表

@ApiImplicitParam：描述一個(gè)請(qǐng)求參數(shù)，可以配置參數(shù)的中文含義，還可以給參數(shù)設(shè)置默認(rèn)值
//eg:
    @ApiImplicitParam(name="username",value="用戶名",required=true)

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>2.0.9</version>
</dependency>

@Configuration
@EnableSwagger2
@EnableKnife4j
//@EnableSwagger2WebMvc 2.6以上報(bào)空指針異常則需要添加
@Import(BeanValidatorPluginsConfiguration.class)
public class SwaggerConfiguration {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)      // 選擇swagger2版本
                .apiInfo(apiInfo())         //定義api文檔匯總信息
                .select()
                .apis(RequestHandlerSelectors
                        .basePackage("com.example"))  // 指定生成api文檔的包
                .paths(PathSelectors.any())     // 指定所有路徑
                .build();
    }

    /**
     * 構(gòu)建文檔api信息
     *
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("")     // 文檔標(biāo)題
                .contact(new Contact("", "", ""))   //聯(lián)系人信息
                .description("")      //描述
                .version("1.0.1")     //文檔版本號(hào)
                .termsOfServiceUrl("")     //網(wǎng)站地址
                .build();
    }
}

spring: 
  profiles: prod #指定環(huán)境
knife4j:
   production: true #開啟屏蔽文檔資源