SpringBoot中整合knife4j介面文件的實踐
阿新 • • 發佈：2020-09-11
在專案開發中，web專案的前後端分離開發，APP開發，需要由前後端工程師共同定義介面，編寫介面文件，之後大家都根據這個介面文件進行開發，到專案結束前都要一直維護
介面文件使得專案開發過程中前後端工程師有一個統一的檔案進行溝通交流開發，專案維護中或者專案人員更迭，方便後期人員檢視、維護
一、介面先賞
1、首頁
2、介面文件
3、除錯
二、整合 knife4j
1、引入 maven 依賴
<!-- knife4j介面文件 start --> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>2.0.2</version> </dependency> <!-- 避免版本衝突 --> <dependency> <groupId>com.google.guava</groupId> <artifactId>guava</artifactId> <version>29.0-jre</version> </dependency>
一般情況我們只需要引入 knife4j 的依賴即可，但是有時會出現 guava 的版本衝突，所以，我們把 guava 一起引入進來
2、knife4j 配置檔案
建立 Knife4jConfig 檔案
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* knife4j 配置
*
* @Author Lizhou
*/
@Configuration
@EnableSwagger2
public class Knife4jConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.zyxx"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("SpringBoot專案 後臺服務API介面文件")
.description("使用 knife4j 搭建的後臺服務API介面文件")
.termsOfServiceUrl("http://localhost:8080/")
.contact("lizhou")
.version("1.0.0")
.build();
}
}
整體配置與 Swagger2 幾乎一致，掃描 controller 所在的包
3、啟動類
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* knife4j 配置
*
* @Author Lizhou
*/
@Configuration
@EnableSwagger2
public class Knife4jConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.zyxx"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("SpringBoot專案 後臺服務API介面文件")
.description("使用 knife4j 搭建的後臺服務API介面文件")
.termsOfServiceUrl("http://localhost:8080/")
.contact("lizhou")
.version("1.0.0")
.build();
}
}我們需要開放其靜態資源的訪問，啟動類實現 WebMvcConfigurer 介面，重寫 addResourceHandlers 方法
4、訪問文件
啟動專案，訪問路徑http://localhost:8080/doc.html
三、注意
訪問時，如果提示 knife4j 文件異常，檢查下自己的攔截器是否沒有放開 knife4j 所需要的請求
需要在攔截器，放開請求
package com.zyxx.common.config;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import java.util.ArrayList;
import java.util.List;
/**
* 註冊攔截器
*
* @Author Lizhou
**/
@Configuration
public class WebConfigurer implements WebMvcConfigurer {
@Autowired
private LoginInterceptor loginHandlerInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
InterceptorRegistration ir = registry.addInterceptor(loginHandlerInterceptor);
// 攔截路徑
ir.addPathPatterns("/*");
// 不攔截路徑
List<String> irs = new ArrayList<String>();
irs.add("/login");
irs.add("/api/*");
// 開放knife4j
irs.add("/doc.html");
irs.add("/service-worker.js");
irs.add("/swagger-resources");
ir.excludePathPatterns(irs);
}
}
四、使用
使用註解的方式與 swagger2 是一樣的
1、controller
import com.zyxx.common.utils.ResponseResult;
import com.zyxx.sbm.service.MgtUserService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
/**
* <p>
* 使用者資訊表 前端控制器
* </p>
*
* @author lizhou
* @since 2020-06-30
*/
@Api(tags = "後臺管理端--使用者模組")
@Controller
@RequestMapping("/mgt-user")
public class MgtUserController {
@Autowired
private MgtUserService mgtUserService;
@ApiOperation(value = "分頁查詢使用者資料",notes = "分頁查詢使用者資料")
@ApiImplicitParams({
@ApiImplicitParam(name = "page",value = "頁碼數",required = true),@ApiImplicitParam(name = "limit",value = "每頁條數",required = true)
})
@GetMapping("list")
@ResponseBody
public ResponseResult listUser(int page,int limit) {
return mgtUserService.listUser(page,limit);
}
}
@Api，整個類的註釋
@ApiOperation，方法上的註釋
@ApiImplicitParams，引數列表的註釋
@ApiImplicitParam，每一個引數的註釋
2、實體類
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.extension.activerecord.Model;
import com.baomidou.mybatisplus.annotation.TableId;
import java.io.Serializable;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.experimental.Accessors;
/**
* <p>
* 使用者資訊表
* </p>
*
* @author lizhou
* @since 2020-06-30
*/
@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
@ApiModel(value="mgt_user物件",description="使用者資訊物件")
public class MgtUser extends Model<MgtUser> {
private static final long serialVersionUID = 1L;
@TableId(value = "id",type = IdType.AUTO)
@ApiModelProperty(value = "主鍵ID")
private Long id;
@ApiModelProperty(value = "姓名")
private String name;
@ApiModelProperty(value = "年齡")
private Integer age;
@ApiModelProperty(value = "技能")
private String skill;
@ApiModelProperty(value = "評價")
private String evaluate;
@ApiModelProperty(value = "分數")
private Long fraction;
@Override
protected Serializable pkVal() {
return this.id;
}
}
@ApiModel，實體類的註解
@ApiModelProperty，欄位的註解
到此這篇關於SpringBoot中整合knife4j介面文件的實踐的文章就介紹到這了,更多相關SpringBoot整合knife4j內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！