1.导入依赖
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>${knife4j-spring-boot.version}</version>
</dependency>
2.再配置文件中打开日志
knife4j.enable=true
3.写配置文件
package com.example.studytest.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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;
@Slf4j
@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {
private static final String BASE_PACKAGE = "com.example";
private static final String GROUP_NAME = "学习测试";
private static final String HOST = "http://localhost";
private static final String TITLE = "学习测试-在线API文档";
private static final String DESCRIPTION = "学习测试-在线API文档";
private static final String TERMS_OF_SERVICE_URL = "http://www.apache.org/licenses/LICENSE-2.0";
private static final String CONTACT_NAME = "学习测试";
private static final String CONTACT_URL = "http://www.baipiaozhong.com";
private static final String CONTACT_EMAIL = "helloxiaoxiaobai@163.com";
private static final String VERSION = "2.0";
@Autowired
private OpenApiExtensionResolver openApiExtensionResolver;
public Knife4jConfiguration() {
log.debug("创建配置类对象:Knife4jConfiguration");
}
@Bean
public Docket docket() {
return new Docket(DocumentationType.SWAGGER_2)
.host(HOST)
.apiInfo(apiInfo())
.groupName(GROUP_NAME)
.select()
.apis(RequestHandlerSelectors.basePackage(BASE_PACKAGE))
.paths(PathSelectors.any())
.build()
.extensions(openApiExtensionResolver.buildExtensions(GROUP_NAME));
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title(TITLE)
.description(DESCRIPTION)
.termsOfServiceUrl(TERMS_OF_SERVICE_URL)
.contact(new Contact(CONTACT_NAME, CONTACT_URL, CONTACT_EMAIL))
.version(VERSION)
.build();
}
}
4.成功运行。