SpringBoot(九) - Swagger

1、依賴

<!-- swagger 核心 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.8.0</version>
</dependency>

2、核心啟動類的註解

@EnableSwagger2  //啟用 Swagger
@EnableSwaggerBootstrapUI //啟用 BootstrapUI
//經過測試 只添加 @EnableSwagger2 就可以 (如果不可以再添加試試)

3、Swagger 的 註解解釋

3.1 實體上的註解

//模型數據對應的 實體註解
@ApiMode(value = "",description = "")

//模型數據對應的 屬性註解
@ApiModelProperty(value = "")  

3.2 controller上的註解

//寫在controller上面，用於描述當前處理類支持的主要功能，包括版本說明
@Api(tags = "") 

//寫在目標請求處理方法上，用戶描述當前方法支持的功能，屬性value-方法的概述描述，屬性notes-方法的詳細描述
@ApiOperation(value = "",notes = "")

//參數說明註解，將介面的所有參數說明，進行歸類，避免多個參數@ApiParam
@ApiImplicitParams(
    @ApiImplicitParam(required = false,name = "",value = "")
)

//響應碼和響應說明
@ApiResponses({
    @ApiResponse(code = 201,message = "參數為空"),
    @ApiResponse(code = 202,message = "參數非法")
})

//參數說明註解
@RequestParam(value = "",required = false) 

4、UI界面

4.1 ui 依賴

<!-- swagger ui 界面 swagger-ui.html 官方ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.8.0</version>
</dependency>

<!-- swagger-bootstrap-ui包 /doc.html 推薦使用 bootstrap 的ui  -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.9.3</version>
</dependency>

<!-- 引入swagger-ui-layer包 /docs.html 瞭解-->
<dependency>
    <groupId>com.github.caspar-chen</groupId>
    <artifactId>swagger-ui-layer</artifactId>
    <version>1.1.3</version>
</dependency>

<!-- 引入swagger-mg-ui 包 /document.html 瞭解 -->
<dependency>
    <groupId>com.zyplayer</groupId>
    <artifactId>swagger-mg-ui</artifactId>
    <version>1.0.6</version>
</dependency>

4.2 UI頁面的展示

4.2.1 swagger 官方UI頁面

4.2.2 bootstrap 的UI頁面