一、介紹
先看效果
①：Swagger 介紹
Swagger 是一個規范和完整的框架，用于生成、描述、調用和可視化 RESTful 風格的 Web 服務(https://swagger.io/)。 它的主要作用是：
-
使得前后端分離開發更加方便，有利于團隊協作
-
接口的文檔在線自動生成，降低后端開發人員編寫接口文檔的負擔
-
功能測試
Spring已經將Swagger納入自身的標準，建立了Spring-swagger項目，現在叫Springfox。通過在項目中引入Springfox ，即可非常簡單快捷的使用Swagger
②：knife4j介紹
knife4j是為Java MVC框架集成Swagger生成Api文檔的增強解決方案,前身是swagger-bootstrap-ui,取名kni4j是希望它能像一把匕首一樣小巧,輕量,并且功能強悍!
二、使用步驟
官方文檔：https://doc.xiaominfo.com/
①：引入依賴
<!-- 導入 knife4j--><dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-spring-boot-starter</artifactId><version>3.0.3</version></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency>
②：添加配置類
1.WebMvcConfiguration
@Configuration
public class WebMvcConfiguration {/*** 加入 knife4j 相關配置 通過knife4j生成接口文檔* @return*/@Beanpublic Docket docket() {ApiInfo apiInfo = new ApiInfoBuilder().title("數據統計項目接口文檔").version("2.0").description("數據統計項目接口文檔").build();Docket docket = new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo).select().apis(RequestHandlerSelectors.basePackage("com.sanss.djyp.controller")).paths(PathSelectors.any()).build();return docket;}/*** 設置靜態資源映射 設置靜態資源映射，否則接口文檔頁面無法訪問* @param registry*/protected void addResourceHandlers(ResourceHandlerRegistry registry) {registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");}
}
③：常用注解使用
1.通過注解可以控制生成的接口文檔，使接口文檔擁有更好的可讀性，常用注解如下：
| 注解 | 說明 |
|---|---|
| @Api | 用在類上，例如Controller，表示對類的說明 |
| @ApiModel | 用在類上，例如entity、DTO、VO |
| @ApiModelProperty | 用在屬性上，描述屬性信息 |
| @ApiOperation | 用在方法上，例如Controller的方法，說明方法的用途、作用 |
接下來，使用上述注解，生成可讀性更好的接口文檔
1.controller層
@Api(tags = "統攬數據回收操作接口")
2.Controller層
@ApiOperation(value = "請求設備信息 xxx 天失敗的數據")
3.請求時傳遞的數據對象
類：@ApiModel(description = "請求接口時傳遞的數據模型")
屬性：@ApiModelProperty(value = "日期（某一天）類型 java.util.Date")
3.請求返回的數據格式
類：@ApiModel(description = "直播返回的數據格式")
屬性：@ApiModelProperty(value = "主鍵值")
三、啟動服務
訪問：http://localhost:8082/doc.html
四、開啟請求頭中攜帶token
①：默認情況下是不能設置請求頭的
②：開啟動態請求參數
③：效果
④：設置全局參數token
