SpringBoot与knif4j学习

已于 2023-02-02 21:58:59 修改
阅读量1.7k 收藏 30
点赞数 18
文章标签： spring boot java spring
于 2022-03-01 18:42:00 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_45072503/article/details/123211122
版权

SpringBoot与knif4j学习

创建Springboot项目

第一步创建项目

路径：File ->New-> Project -> New Project ->Spring Initializr ->Next
在这里插入图片描述

第二步

选择自己需要的包 ->Finish
在这里插入图片描述
或者使用springBoot官网快速创建项目
在这里插入图片描述

第三步配置application.yml

server:
  port: 8080

第四步引入包

pom.xml文件配置

<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter</artifactId>
		</dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
			<version>2.6.4</version>
		</dependency>
	</dependencies>

第五步创建测试类

创建一个TestController

@Controller
public class TestController {

    @GetMapping("/test")
    @ResponseBody
    public String test(){
        return "Ok";
    }
}

第六步浏览器访问地址

如下图所示：
在这里插入图片描述

配置knife4j

官网

第一步 在pom.xml中添加knife4j的包

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

第二步 创建Swagger配置依赖

@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {

    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .title("swagger-bootstrap-ui-demo RESTful APIs")
                        .description("# swagger-bootstrap-ui-demo RESTful APIs")
                        .termsOfServiceUrl("http://www.xx.com/")
                        .version("1.0")
                        .build())
                //分组名称
                .groupName("2.X版本")
                .select()
                //这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.mcc.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
}

**注意：**apis的扫描包路径需要改成自己的

第三步 启动项目发现报错如下

Error starting ApplicationContext. To display the conditions report re-run your application with 'debug' enabled.
2022-03-01 18:16:49.020 ERROR 12556 --- [           main] o.s.boot.SpringApplication               : Application run failed

org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException
	at org.springframework.context.support.DefaultLifecycleProcessor.doStart(DefaultLifecycleProcessor.java:181) ~[spring-context-5.3.16.jar:5.3.16]
	at org.springframework.context.support.DefaultLifecycleProcessor.access$200(DefaultLifecycleProcessor.java:54) ~[spring-context-5.3.16.jar:5.3.16]
	at org.springframework.context.support.DefaultLifecycleProcessor$LifecycleGroup.start(DefaultLifecycleProcessor.java:356) ~[spring-context-5.3.16.jar:5.3.16]
	at java.lang.Iterable.forEach(Iterable.java:75) ~[na:1.8.0_202]
	at org.springframework.context.support.DefaultLifecycleProcessor.startBeans(DefaultLifecycleProcessor.java:155) ~[spring-context-5.3.16.jar:5.3.16]
	at org.springframework.context.support.DefaultLifecycleProcessor.onRefresh(DefaultLifecycleProcessor.java:123) ~[spring-context-5.3.16.jar:5.3.16]
	at org.springframework.context.support.AbstractApplicationContext.finishRefresh(AbstractApplicationContext.java:935) ~[spring-context-5.3.16.jar:5.3.16]
	at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:586) ~[spring-context-5.3.16.jar:5.3.16]
	at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.refresh(ServletWebServerApplicationContext.java:145) ~[spring-boot-2.6.4.jar:2.6.4]
	at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:740) [spring-boot-2.6.4.jar:2.6.4]
	at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:415) [spring-boot-2.6.4.jar:2.6.4]
	at org.springframework.boot.SpringApplication.run(SpringApplication.java:303) [spring-boot-2.6.4.jar:2.6.4]
	at org.springframework.boot.SpringApplication.run(SpringApplication.java:1312) [spring-boot-2.6.4.jar:2.6.4]
	at org.springframework.boot.SpringApplication.run(SpringApplication.java:1301) [spring-boot-2.6.4.jar:2.6.4]
	at com.mcc.TestKnif4jApplication.main(TestKnif4jApplication.java:10) [classes/:na]
Caused by: java.lang.NullPointerException: null
	at springfox.documentation.spring.web.WebMvcPatternsRequestConditionWrapper.getPatterns(WebMvcPatternsRequestConditionWrapper.java:56) ~[springfox-spring-webmvc-3.0.0.jar:3.0.0]
	at springfox.documentation.RequestHandler.sortedPaths(RequestHandler.java:113) ~[springfox-core-3.0.0.jar:3.0.0]
	at springfox.documentation.spi.service.contexts.Orderings.lambda$byPatternsCondition$3(Orderings.java:89) ~[springfox-spi-3.0.0.jar:3.0.0]
	at java.util.Comparator.lambda$comparing$77a9974f$1(Comparator.java:469) ~[na:1.8.0_202]
	at java.util.TimSort.countRunAndMakeAscending(TimSort.java:355) ~[na:1.8.0_202]
	at java.util.TimSort.sort(TimSort.java:220) ~[na:1.8.0_202]
	at java.util.Arrays.sort(Arrays.java:1512) ~[na:1.8.0_202]
	at java.util.ArrayList.sort(ArrayList.java:1462) ~[na:1.8.0_202]
	at java.util.stream.SortedOps$RefSortingSink.end(SortedOps.java:387) ~[na:1.8.0_202]
	at java.util.stream.Sink$ChainedReference.end(Sink.java:258) ~[na:1.8.0_202]
	at java.util.stream.Sink$ChainedReference.end(Sink.java:258) ~[na:1.8.0_202]
	at java.util.stream.Sink$ChainedReference.end(Sink.java:258) ~[na:1.8.0_202]
	at java.util.stream.Sink$ChainedReference.end(Sink.java:258) ~[na:1.8.0_202]
	at java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:482) ~[na:1.8.0_202]
	at java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:471) ~[na:1.8.0_202]
	at java.util.stream.ReduceOps$ReduceOp.evaluateSequential(ReduceOps.java:708) ~[na:1.8.0_202]
	at java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234) ~[na:1.8.0_202]
	at java.util.stream.ReferencePipeline.collect(ReferencePipeline.java:499) ~[na:1.8.0_202]
	at springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider.requestHandlers(WebMvcRequestHandlerProvider.java:81) ~[springfox-spring-webmvc-3.0.0.jar:3.0.0]
	at java.util.stream.ReferencePipeline$3$1.accept(ReferencePipeline.java:193) ~[na:1.8.0_202]
	at java.util.ArrayList$ArrayListSpliterator.forEachRemaining(ArrayList.java:1382) ~[na:1.8.0_202]
	at java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:481) ~[na:1.8.0_202]
	at java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:471) ~[na:1.8.0_202]
	at java.util.stream.ReduceOps$ReduceOp.evaluateSequential(ReduceOps.java:708) ~[na:1.8.0_202]
	at java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234) ~[na:1.8.0_202]
	at java.util.stream.ReferencePipeline.collect(ReferencePipeline.java:499) ~[na:1.8.0_202]
	at springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper.withDefaults(AbstractDocumentationPluginsBootstrapper.java:107) ~[springfox-spring-web-3.0.0.jar:3.0.0]
	at springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper.buildContext(AbstractDocumentationPluginsBootstrapper.java:91) ~[springfox-spring-web-3.0.0.jar:3.0.0]
	at springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper.bootstrapDocumentationPlugins(AbstractDocumentationPluginsBootstrapper.java:82) ~[springfox-spring-web-3.0.0.jar:3.0.0]
	at springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper.start(DocumentationPluginsBootstrapper.java:100) ~[springfox-spring-web-3.0.0.jar:3.0.0]
	at org.springframework.context.support.DefaultLifecycleProcessor.doStart(DefaultLifecycleProcessor.java:178) ~[spring-context-5.3.16.jar:5.3.16]
	... 14 common frames omitted

Disconnected from the target VM, address: '127.0.0.1:49618', transport: 'socket'

第四步 配置application.yml 如下

spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

第五步 修改TestController如下

@Api(tags = "测试knife4j")
@Controller
public class TestController {

    @ApiImplicitParam(name = "name",value = "姓名",required = true)
    @ApiOperation(value = "测试使用")
    @GetMapping("/test")
    @ResponseBody
    public String test(String name){
        return name;
    }
}

第六步 启动项目访问地址

地址（http://127.0.0.1:8080/doc.html）
出现如下图所示：
在这里插入图片描述

第七步 接口内容如下图

在这里插入图片描述

第八步 测试接口如下图

在这里插入图片描述

knif4j使用yml配置版本

第一步 yml配置如下

springdoc:
  swagger-ui:
    path: /swagger-ui.html
    tags-sorter: alpha
    operations-sorter: alpha
  api-docs:
    path: /v3/api-docs
  group-configs:
    - group: 'default'
      paths-to-match: '/**'
      packages-to-scan: com.mcc.springbootdemo

knife4j:
  enable: true
  setting:
    language: zh_cn
    swagger-model-name: com.mcc.springbootdemo.entity
  documents:
    - name: 标题1
      locations: classpath:markdown/*
      group: default
    - name: 标题2
      locations: classpath:markdown1/*
      group: 用户模块

第二步 注入依赖

<!-- knife4j -->
		<dependency>
			<groupId>com.github.xiaoymin</groupId>
			<artifactId>knife4j-openapi2-spring-boot-starter</artifactId>
			<version>4.0.0</version>
		</dependency>
心，随梦而扬
关注
  • 18
    点赞
  • 踩
  • 30
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
org.springframework.context.ApplicationContextException: Failed to start bean ‘documentationPluginsB
weixin_48568302的博客
08-04 1万+
org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException
[完美解决] Failed to start bean ‘webServerStartStop‘； nested exception is java.lang.reflect.UndeclaredTh
热门推荐
xujunming668的博客
01-16 4万+
org.springframework.context.ApplicationContextException: Failed to start bean ‘webServerStartStop’; nested exception is java.lang.reflect.UndeclaredThrowableException 集群nacos后 用了nginx作为代理, 启动时候一直转圈圈…
springboot3 集成knife4j
最新发布
一个写了10年bug的程序员日常笔记。
04-22 1305
Knife4j是一个集Swagger2 和 OpenAPI3为一体的增强解决方案。Knife4j · 集Swagger2及OpenAPI3为一体的增强解决方案. | Knife4jjava：17。
[错误解决] Spring Boot Swagger 启动报错 getPatterns(WebMvcPatternsRequestConditionWrapper.java:56)
idbanfan的博客
01-25 4570
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> [错误] at springfox.documentati..
记录一次swagger莫名其妙坏了
qq_36417022的博客
10-20 308
示例：@ApiImplicitParam(name = "xmmc", value = "项目名称", required = true, dataType = "String", paramType = "query", dataTypeClass = String.class)Controller里面检查@ApiImplicitParam注解里面是否为空，会导致swagger扫描注解get不到ApiImplicitParam里的name等属性导致空指针。
springboot2.6.7使用swagger2出现错误
weixin_43308917的博客
05-23 1808
Caused by: java.lang.NullPointerException: null at springfox.documentation.spi.service.contexts.Orderings$8.compare(Orderings.java:113) ~[springfox-spi-2.7.0.jar:2.7.0] at springfox.documentation.spi.service.contexts.Orderings$8.compare(Orderings.java:11
springboot-knife4j 实现API文档
09-05
API文档
spring boot 集成swagger+knife4j，集成mybatis-plus和代码生成器
10-28
spring boot快速上手示例，集成了swagger+knife4j接口文档，集成mybatis-plus持久化，统一的数据返回封装，集成mybatis-plus-generator代码生成器，加入了lombok框架，一个完成的sping boot 示例项目，简单易上手
SpringMVC4的教程
04-04
SpringMVC4的教程看完，你基本上会使用SpringMVC4了，注意SpringMVC4和3是有区别的，网上大多数配置是3的配置方式
QtSwissArmyKnife：QSAK（Qt瑞士军刀）是基于Qt的多功能，跨平台调试工具
02-05
QtSwissArmyKnife：QSAK（Qt瑞士军刀）是基于Qt的多功能，跨平台调试工具
KMF3（M = Mn，Co和Ni）的晶体结构和电传输性能
03-29
对于KMnF3，KCoF3和KNiF3，单位参数分别为4.189 46（4），4.075 58（4）和4.025 70（2）。 对于这三种化合物，在250至280 K的温度范围内，随温度变化的电迁移特性观察到金属-绝缘体的转变，这被认为与这种材料的...
Failed to start bean ‘documentationPluginsBootstrapper‘； nested exception is java.lang.NullPoint
qq_43681532的博客
11-26 725
当你的spring-boot版本是2.6.x并且你的swagger版本是3.0.0以上的时候，项目启动会报错“org.springframework.context.ApplicationContextException:nested。
spring dubbo @Reference Caused by: java.lang.NullPointerException: null 空指针异常
qq_44730056的博客
08-04 1152
springboot dubbo @Reference Caused by: java.lang.NullPointerException: null 空指针异常dubbo @Reference 空指针异常错误代码摘要原因处理方法 dubbo @Reference 空指针异常 错误代码摘要 Caused by: org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'userService
解决图片上传时保存信息:java.lang.NullPointerException: null 空指针异常解决
weixin_44797327的博客
11-21 6876
ERROR 73168 — [ XNIO-1 task-28] c.u.l.c.e.GlobalExceptionHandler : 异常信息uri=/sys/WxMainHome/saveEditIn,method=POST,e={} 解决办法（报错信息下） 报错信息： 找到自己写的代码 java.lang.NullPointerException: null at io.und...
Swagger-ui.html 404 NOT FOUND
m0_47603004的博客
11-02 1515
swagger-ui.html 404
Swagger报错：Caused by: java.lang.NullPointerException: null at springfox.documentation.spring.web
流楚丶格念的博客
11-18 882
因为 Springfox 使用的路径匹配是基于AntPathMatcher 的，而 Spring Boot 2.6.X等低版本使用的是 PathPatternMatcher。在yml（yaml）里添加如下配置，重写匹配一下路径。
使用swagger3是项目无法启动 或 无法获取api信息解决方法
weixin_49245941的博客
08-13 1063
解决办法：将依赖中的spring-plugin-core去除，并添加高版本。
Caused by: java.lang.NullPointerException
qq_45258864的博客
09-20 4188
错误提示 E/AndroidRuntime: FATAL EXCEPTION: main Process: com.example.demo1, PID: 31860 java.lang.RuntimeException: Unable to start activity ComponentInfo{com.example.demo1/com.example.demo1.MainActivity}: java.lang.NullPointerException: Attempt to inv
渗透技巧基于Swagger-UI的XSS
网安君的博客
08-25 8182
swagger-ui是一个允许 API 交互和可视化的库，Swagger-UI有一个特性它允许您向 API 规范提供URL一个yaml或json文件，它将被获取并显示给用户。该漏洞产生的原因是swagger-ui使用了一个过时的库DomPurify（DOMPurify是一个开源的基于DOM的快速XSS净化工具。输入HTML元素，然后通过DOM解析递归元素节点，进行净化，输出安全的HTML。），结合库的特性允许获得由查询参数控制的DOM型XSS。
springboot集成knif4j
08-26
To integrate Spring Boot with Knife4j, you can follow these steps: 1. Add the required dependencies to your project's `pom.xml` file: ```xml <groupId>com.github.xiaoymin</groupId> <artifactId>...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值