knife4j是為Java MVC框架集成Swagger生成Api文檔的增強解決方案,前身是swagger-bootstrap-ui,取名knife4j是希望它能像一把匕首一樣小巧,輕量,并且功能強悍!其底層是對Springfox的封裝，使用方式也和Springfox一致，只是對接口文檔UI進行了優(yōu)化。
核心功能：
-
文檔說明：根據(jù)Swagger的規(guī)范說明，詳細列出接口文檔的說明，包括接口地址、類型、請求示例、請求參數(shù)、響應示例、響應參數(shù)、響應碼等信息，對該接口的使用情況一目了然。
-
在線調試：提供在線接口聯(lián)調的強大功能，自動解析當前接口參數(shù),同時包含表單驗證，調用參數(shù)可返回接口響應內容、headers、響應時間、響應狀態(tài)碼等信息，幫助開發(fā)者在線調試。
入門案例：
1.創(chuàng)建spring-boot工程knife4j_demo并配置pom.xml文件
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.2.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>knife4j_demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>knife4j_demo</name>
<description>Demo project for Spring Boot</description>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>2.0.1</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
</dependencies>
</project>
?從依賴關系中也能看出它是對Springfox的封裝，因此使用方式一直
2.創(chuàng)建實體類User和Order和接口UserController和OrderController，并使用swagger的注解
3.創(chuàng)建配置屬性類SwaggerProperties
package com.example.config;
import lombok.*;
import org.springframework.boot.context.properties.ConfigurationProperties;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
/*
*配置屬性類，用于封裝接口文檔相關屬性，從配置文件讀取信息封裝成當前對象
*/
@Data
@ConfigurationProperties(prefix = "myknife4j.swagger")
public class SwaggerProperties {
private String title = "在線文檔"; //標題
private String group = ""; //自定義組名
private String description = "在線文檔"; //描述
private String version = "1.0"; //版本
private Contact contact = new Contact(); //聯(lián)系人
private String basePackage = ""; //swagger會解析的包路徑
private List<String> basePath = new ArrayList<>(); //swagger會解析的url規(guī)則
private List<String> excludePath = new ArrayList<>();//在basePath基礎上需要排除的url規(guī)則
private Map<String, DocketInfo> docket = new LinkedHashMap<>(); //分組文檔
public String getGroup() {
if (group == null || "".equals(group)) {
return title;
}
return group;
}
@Data
public static class DocketInfo {
private String title = "在線文檔"; //標題
private String group = ""; //自定義組名
private String description = "在線文檔"; //描述
private String version = "1.0"; //版本
private Contact contact = new Contact(); //聯(lián)系人
private String basePackage = ""; //swagger會解析的包路徑
private List<String> basePath = new ArrayList<>(); //swagger會解析的url規(guī)則
private List<String> excludePath = new ArrayList<>();//在basePath基礎上需要排除的url
public String getGroup() {
if (group == null || "".equals(group)) {
return title;
}
return group;
}
}
@Data
public static class Contact {
private String name = ""; //聯(lián)系人
private String url = ""; //聯(lián)系人url
private String email = ""; //聯(lián)系人email
}
}
4.創(chuàng)建配置類SwaggerAutoConfiguration
package com.example.config;
import com.google.common.base.Predicate;
import com.google.common.base.Predicates;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.BeanFactoryAware;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.config.ConfigurableBeanFactory;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RequestMethod;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;
import java.util.LinkedList;
import java.util.List;
@Configuration
@ConditionalOnProperty(name = "myknife4j.swagger.enabled", havingValue = "true",
matchIfMissing = true)
@EnableSwagger2
@EnableConfigurationProperties(SwaggerProperties.class)
public class SwaggerAutoConfiguration implements BeanFactoryAware {
@Autowired
SwaggerProperties swaggerProperties;
private BeanFactory beanFactory;
@Bean
@ConditionalOnMissingBean
public List<Docket> createRestApi(){
ConfigurableBeanFactory configurableBeanFactory =
(ConfigurableBeanFactory) beanFactory;
List<Docket> docketList = new LinkedList<>();
// 沒有分組
if (swaggerProperties.getDocket().isEmpty()) {
Docket docket = createDocket(swaggerProperties);
configurableBeanFactory.registerSingleton(swaggerProperties.getTitle(),
docket);
docketList.add(docket);
return docketList;
}
// 分組創(chuàng)建
for (String groupName : swaggerProperties.getDocket().keySet()){
SwaggerProperties.DocketInfo docketInfo =
swaggerProperties.getDocket().get(groupName);
ApiInfo apiInfo = new ApiInfoBuilder()
//頁面標題
.title(docketInfo.getTitle())
//創(chuàng)建人
.contact(new Contact(docketInfo.getContact().getName(),
docketInfo.getContact().getUrl(),
docketInfo.getContact().getEmail()))
//版本號
.version(docketInfo.getVersion())
//描述
.description(docketInfo.getDescription())
.build();
// base-path處理
// 當沒有配置任何path的時候，解析/**
if (docketInfo.getBasePath().isEmpty()) {
docketInfo.getBasePath().add("/**");
}
List<Predicate<String>> basePath = new ArrayList<>();
for (String path : docketInfo.getBasePath()) {
basePath.add(PathSelectors.ant(path));
}
// exclude-path處理
List<Predicate<String>> excludePath = new ArrayList<>();
for (String path : docketInfo.getExcludePath()) {
excludePath.add(PathSelectors.ant(path));
}
Docket docket = new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo)
.groupName(docketInfo.getGroup())
.select()
//為當前包路徑
.apis(RequestHandlerSelectors.basePackage(docketInfo.getBasePackage()))
.paths(Predicates.and(Predicates.not(Predicates.or(excludePath)),Predicates.or(basePath)))
.build();
configurableBeanFactory.registerSingleton(groupName, docket);
docketList.add(docket);
}
return docketList;
}
//構建 api文檔的詳細信息
private ApiInfo apiInfo(SwaggerProperties swaggerProperties) {
return new ApiInfoBuilder()
//頁面標題
.title(swaggerProperties.getTitle())
//創(chuàng)建人
.contact(new Contact(swaggerProperties.getContact().getName(),
swaggerProperties.getContact().getUrl(),
swaggerProperties.getContact().getEmail()))
//版本號
.version(swaggerProperties.getVersion())
//描述
.description(swaggerProperties.getDescription())
.build();
}
//創(chuàng)建接口文檔對象
private Docket createDocket(SwaggerProperties swaggerProperties) {
//API 基礎信息
ApiInfo apiInfo = apiInfo(swaggerProperties);
// base-path處理
// 當沒有配置任何path的時候，解析/**
if (swaggerProperties.getBasePath().isEmpty()) {
swaggerProperties.getBasePath().add("/**");
}
List<Predicate<String>> basePath = new ArrayList<>();
for (String path : swaggerProperties.getBasePath()) {
basePath.add(PathSelectors.ant(path));
}
// exclude-path處理
List<Predicate<String>> excludePath = new ArrayList<>();
for (String path : swaggerProperties.getExcludePath()) {
excludePath.add(PathSelectors.ant(path));
}
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo)
.groupName(swaggerProperties.getGroup())
.select()
.apis(RequestHandlerSelectors.basePackage(swaggerProperties.getBasePackage()))
.paths(Predicates.and(Predicates.not(Predicates.or(excludePath)),Predicates.or(basePath)))
.build();
}
@Override
public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
this.beanFactory = beanFactory;
}
}5.配置application.yml文件
server:
port: 7788
# 對應的SwaggerProperties配置類中的屬性
myknife4j:
swagger:
enabled: true #是否啟用swagger
title: 測試標題
description: 測試文檔
docket:
controller: # 對應的SwaggerProperties配置類中的名為docket的map集合的key
title: controller模塊
description: controller模塊測試文檔
contact:
name: xxx
url: www.xxx.com
email: xxxxx.@xx.com
base-package: com.example.controller6.執(zhí)行啟動類main方法啟動項目，訪問地址：http://服務地址:端口/doc.html
如果接口文檔不分組，我們可以修改application.yml文件：文章來源：http://www.zghlxwxcb.cn/news/detail-403288.html
server:
port: 7788
# 對應的SwaggerProperties配置類中的屬性
myknife4j:
swagger:
enabled: true #是否啟用swagger
title: test模塊
base-package: com.example.controller
文章來源地址http://www.zghlxwxcb.cn/news/detail-403288.html
到了這里，關于knife4j接口文檔的文章就介紹完了。如果您還想了解更多內容，請在右上角搜索TOY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關文章，希望大家以后多多支持TOY模板網(wǎng)！
