学无先后,达者为师

网站首页 编程语言 正文

springboot项目整合配置knife4j

作者:小黑孩666 更新时间: 2022-07-22 编程语言

一、在pom文件中加入依赖

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

二、在spring boot的配置文件(application.properties)中加入以下命令

knife4j.enable=true

三、添加一个配置类


import com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver;
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;

@Configuration
@Slf4j
@EnableSwagger2WebMvc
public class Knfie4jConfiguration {

    
    /**
     * 分组名称
     */
    private String groupName = "product";
    
    
    @Autowired
    private OpenApiExtensionResolver openApiExtensionResolver;

    @Bean
    public Docket docket() {
        String groupName = "1.0.0";
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .host("主机名")
                .apiInfo(apiInfo())
                .groupName(groupName)
                .select()
                .apis(RequestHandlerSelectors.basePackage("【重要】指定Controller包路径"))
                .paths(PathSelectors.any())
                .build()
                .extensions(openApiExtensionResolver.buildExtensions(groupName));
        return docket;
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("标题")
                .description("简介描述")
                .termsOfServiceUrl("服务条款URL,可以使用(http://www.apache.org/licenses/LICENSE-2.0)")
                .contact(new Contact("联系人", "联系网址", "联系邮箱"))
                .version("版本号")
                .build();
    }
}

原文链接:https://blog.csdn.net/xiaoheihai666/article/details/125621944

栏目分类
最近更新