Swagger及knife4j的基本使用詳解

<!--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 {
    /**
     * 建立API應用
     * apiInfo() 增加API相關資訊
     * 通過select()函數返回一個ApiSelectorBuilder範例,用來控制哪些介面暴露給Swagger來展現，
     * 指定掃描的包路徑來定義指定要建立API的目錄。
     * @return
     */
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(adminApiInfo())
                 //.enable(false) //enable是否啟動Swagger 如果為false，則swagger不能在瀏覽器中存取
                .groupName("adminApi")
                .select()
                //RequestHandlerSelectors 設定要掃描介面的方式
                //basePackage: 指定要掃描的包
                //any()：掃描全部
                //none()不掃描
                //withClassAnnotation: 掃描類上的註解，引數為一個註解的反射物件
                //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("系統介面描述")
                .version("1.0")
                //作者資訊
                .contact(new Contact("張三","http://baidu.com","12345678@qq.com"))
                .build();
    }
}

@ApiModel("使用者實體類")
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：修飾整個類，描述Controller的作用,放在類上

@ApiOperation：描述一個類的一個方法，或者說一個介面

@ApiParam：單個引數描述

@ApiModel：用物件來接收引數

@ApiProperty：用物件接收引數時，描述物件的一個欄位

@ApiResponses：HTTP響應整體描述

@ApiResponse：HTTP響應其中1個描述

@ApiIgnore：使用該註解忽略這個API

@ApiError ：發生錯誤返回的資訊

@ApiImplicitParams：描述由多個 @ApiImplicitParam 註解的引陣列成的請求參數列

@ApiImplicitParam：描述一個請求引數，可以設定引數的中文含義，還可以給引數設定預設值
//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以上報空指標異常則需要新增
@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();
    }

    /**
     * 構建檔案api資訊
     *
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("")     // 檔案標題
                .contact(new Contact("", "", ""))   //聯絡人資訊
                .description("")      //描述
                .version("1.0.1")     //檔案版本號
                .termsOfServiceUrl("")     //網站地址
                .build();
    }
}

spring: 
  profiles: prod #指定環境
knife4j:
   production: true #開啟遮蔽檔案資源