526互联

springboot集成Knife4j

发布时间 2023-06-05 10:59:37作者: 一群bug

1.springboot我用的 2.7.X

引入maven

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

2.yml添加如下配置

spring:
  ##swagger配置
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

3.然后config配置注入

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
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.ApiSelectorBuilder;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * @Author nitric oxide
 * @Description
 * @Date 6:13 下午 2021/11/11
 */
@Configuration
public class SwaggerConfig {
    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        ApiSelectorBuilder builder = new Docket(DocumentationType.SWAGGER_2)
                .enableUrlTemplating(false)
                .apiInfo(apiInfo())
                // 选择那些路径和api会生成document
                .select()
                // 对所有api进行监控
                .apis(RequestHandlerSelectors.any())
                //这里可以自定义过滤
                .paths(this::filterPath);

        return builder.build();
    }

    //过滤不需要文档的接口
    private boolean filterPath(String path) {
        boolean ret = path.endsWith("/error");
        if (ret) {
            return false;
        }
        //这块可以写其他的过滤逻辑
        return true;
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("demo接口文档")//标题
                .description("简介")//简介
                .termsOfServiceUrl("http://127.0.0.1")//服务Url
                .version("1.0")
                .contact(new Contact("小郝", "www.baidu.com", "123@qq.com"))
                .build();
    }

4.浏览器访问自己服务的ip+端口+/doc.html

比如我的是   http://127.0.0.1:8080/doc.html