Knife4j是一款基于Swagger 2的在线API文档框架,在Spring Boot中,使用此框架时,需要:
-
添加依赖
-
在配置文件.yml或
.properties
中开启增强模式 -
编写配置类(代码相对固定,建议CV)
关于依赖的代码:
<!-- Knife4j Spring Boot:在线API -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>2.0.9</version>
</dependency>
关于开启增强模式,在.yml或.properties
中添加:
# 开启Knife4j的增强模式
knife4j.enable=true
关于配置类,在项目的根包下创建config.Knife4jConfiguration
,代码如下:
注意:请检查basePackage
属性的值!
package cn.product.config;
import com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
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.service.Contact;
import springfox.documentation.s