栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

springboot 2.6版本使用knife4j的坑

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

springboot 2.6版本使用knife4j的坑

提示:这玩意真的很头疼,由于springboot版本更新太快,容易出现问题,我在这记录下
参考手册:https://doc.xiaominfo.com/knife4j/

文章目录
  • 二、使用步骤
    • 1.引入knife4j 接口管理
    • 2.spring boot进行配置
    • 2.进行Controller测试
  • 三、解决方案
    • 1.yml增加配置
    • 2.运行结果


knife4j是国人开发的一个基于Swagger2技术,为前后端的开发人员的沟通提供便利手段(苦逼后端仔)

二、使用步骤 1.引入knife4j 接口管理

pom.xml:

			
		
		    com.github.xiaoymin
		    knife4j-spring-boot-starter
		    3.0.2
		
2.spring boot进行配置

代码如下(示例):

    public class Knife4jConfig {
	
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .useDefaultResponseMessages(false)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .description("后台接口文档")
                .contact(new Contact("admin", "http://127.0.0.1:8080", ""))
                .version("v1.0")
                .title("接口文档")
                .build();
    }
}

@Bean:这个Bean对象放在自己的IOC容器中;


2.进行Controller测试

代码如下(示例):

@Api(tags = "测试模块")
@RestController
public class IndexController {   
 
	
    @ApiOperation(value="hello接口",notes	="hello接口的描述")
    @GetMapping("/hello")
    public ResultVO hello(){
    	ResultVO rv=new ResultVO();
		rv.setCode(ErrorCode.SUCCESS.getcode());
		rv.setMsg(ErrorCode.SUCCESS.getMsg());
		return rv;
    }
}
 

我们进行测试时候,会发现惊奇 发现有bug,是关于springfox这叼玩意的错,别怕!!


三、解决方案 1.yml增加配置

application.yml

spring:
  mvc:
    pathmatch:
      matching-strategy: ANT_PATH_MATCHER


原因:这是因为Springfox使用的路径匹配是基于AntPathMatcher的, 而Spring Boot 2.6.X使用的是PathPatternMatcher。


ps:knife4J3.0把原来swagger的页面覆盖了,只能打开doc.html,无法打开swagger-ui/index.html


2.运行结果

进入该网站即可:http://localhost:8080/doc.html


转载请注明:文章转载自 www.mshxw.com
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号