springBoo3.0集成knife4j4.1.0的详细教程(swagger3)

 更新时间:2023年07月20日 11:18:56   作者:华义辰  
这篇文章主要介绍了springBoo3.0集成knife4j4.1.0的详细教程(swagger3),本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

温馨提示:

springBoot 版本 3.0+

knife4j 版本 4.1.0

添加依赖:knife4j包含了swagger,openapi3中的依赖,所以加这一个就行。

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
    <version>4.1.0</version>
</dependency>
<!--springBoot相关配置忽略-->

yml文件中配置:

#springdoc相关配置
springdoc:
  swagger-ui:
    path: /swagger-ui.html
    tags-sorter: alpha
    operations-sorter: alpha
  api-docs:
    path: /v3/api-docs
  group-configs:
    - group: 'hyc'
      paths-to-match: '/**'
      packages-to-scan: com.hyc  #改成你自己的包名,一般到启动类的包名
#knife4j相关配置 可以不用改
knife4j:
  enable: true
  setting:
    language: zh_cn
    swagger-model-name: 实体类

然后,就可以启动测试输入地址http://ip:port/doc.html

注解的基本使用可以看下这里:swagger3注解和swagger2的区别

这里主要提下请求参数为文件的时候怎么写

@Parameter(name = "image", description = "图片文件", required = true,schema =@Schema(type = "file"))
在@Parameter参数注解里面加
schema = @Schema(type = "string", format = "binary")

注意:如果实体类没有在页面显示如下:

这是因为你这个实体类没有在controller层使用,没有使用,就不会在这显示的。

到此这篇关于springBoo3.0集成knife4j4.1.0(swagger3)的文章就介绍到这了,更多相关springBoo3集成knife4j内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 一文详解Java中的finalize()方法

    一文详解Java中的finalize()方法

    Java中的finalize()是Object类的一个方法,用于对象被垃圾回收前执行清理操作,这篇文章主要介绍了Java中finalize()方法的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2025-09-09
  • springboot如何实现国际化配置

    springboot如何实现国际化配置

    这篇文章主要介绍了springboot如何实现国际化配置问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-06-06
  • 利用java判断质数的3种方法代码示例

    利用java判断质数的3种方法代码示例

    这篇文章主要给大家介绍了关于利用java判断质数的3种方法,在大于1的整数中,如果只包含1和本身这两个约数,就被称为质数(素数),文中给出了详细的代码示例,需要的朋友可以参考下
    2023-07-07
  • 解读@ConfigurationProperties的基本用法

    解读@ConfigurationProperties的基本用法

    这篇文章主要介绍了@ConfigurationProperties的基本用法,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2025-03-03
  • Spring事务管理只对出现运行期异常进行回滚

    Spring事务管理只对出现运行期异常进行回滚

    Spring的事务管理默认只对出现运行期异常(java.lang.RuntimeException及其子类)进行回滚,需要了解更多Spring事务方面的知识,可详看本文
    2012-11-11
  • 如何用Jfinal连接多个数据库

    如何用Jfinal连接多个数据库

    这篇文章主要介绍了如何用Jfinal连接多个数据库,帮助大家更好的理解和学习使用Jfinal,感兴趣的朋友可以了解下
    2021-03-03
  • SpringBoot启动后启动内嵌浏览器的方法

    SpringBoot启动后启动内嵌浏览器的方法

    这篇文章主要介绍了SpringBoot启动后启动内嵌浏览器的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-12-12
  • Spring中的编程式事务和声明式事务

    Spring中的编程式事务和声明式事务

    Spring框架中,事务管理可以通过编程式事务和声明式事务两种方式实现,编程式事务通过手动编码控制事务的开始、提交和回滚,允许开发者精确控制事务,但增加了代码复杂度,声明式事务则通过@EnableTransactionManagement注解启用事务管理
    2024-11-11
  • 辨析Java中的String与StringBuffer及StringBuilder字符串类

    辨析Java中的String与StringBuffer及StringBuilder字符串类

    这里将为大家来辨析Java中的String与StringBuffer及StringBuilder字符串类型,通常来说StringBuilder的性能更加,需要的朋友可以参考下
    2016-05-05
  • 浅谈@PostConstruct不被调用的原因

    浅谈@PostConstruct不被调用的原因

    这篇文章主要介绍了浅谈@PostConstruct不被调用的原因及分析,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-02-02

最新评论