SpringBoot2.x集成swagger2/knife4j

knife4j就swagger的升级版API文档的一个框架,但是用起来比swagger方便多了，UI更加丰富。

基础环境搭建可参考 swagger配置：swagger2搭建

实现步骤：

 Step1:  导入maven依赖

        <!-- Swagger -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>3.0.3</version>
        </dependency>

 

Step2:  knife4j配置类基本与swagger配置类一致

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
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.EnableSwagger2WebMvc;

// 访问地址localhost:8080/swagger-ui.html
@Configuration
@EnableKnife4j
@EnableSwagger2WebMvc
public class Swagger2Config {

	@Value("${swagger.enable}")
	private Boolean enable;

	@Bean
	public Docket webApiConfig(){
		return new Docket(DocumentationType.SWAGGER_2)
				.groupName("CRM-Api")
				.apiInfo(webApiInfo())
				.enable(enable) // 是否显示
				.select()
				.build();
	}

	private ApiInfo webApiInfo(){
		return new ApiInfoBuilder()
				.title("CRM客户管理系统-Api")
				.description("CRM-Api")
				.version("1.0")
				.contact(new Contact("robin", "", ""))
				.build();
	}

}

 

Step3:  .yml配置

# swagger开启
swagger:
  enable: true
# 是否停用Knife4j文档
knife4j:
  production: false

 

Step4: 访问根目录/doc.html

http://ip:port/doc.html

 

 

 参考自：https://blog.csdn.net/weixin_44739349/article/details/105839318