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使用easyExcel实现导入功能

    Java使用easyExcel实现导入功能

    这篇文章介绍了Java使用easyExcel实现导入功能的方法,文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-10-10
  • Java 采用反射获取class属性值的实现代码

    Java 采用反射获取class属性值的实现代码

    以下是对在Java中采用反射获取class属性值的实现代码进行了分析介绍,需要的朋友可以过来参考下
    2013-08-08
  • 如何处理器拦截器(HandlerInterceptor)

    如何处理器拦截器(HandlerInterceptor)

    这篇文章主要介绍了如何处理器拦截器(HandlerInterceptor)问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-07-07
  • spring循环注入异常问题的解决方案

    spring循环注入异常问题的解决方案

    今天小编就为大家分享一篇关于spring循环注入异常问题的解决方案,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2018-12-12
  • Java中File文件操作类的基础用法

    Java中File文件操作类的基础用法

    这篇文章主要给大家介绍了关于Java中File文件操作类基础用法的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用File类具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2018-07-07
  • 实例讲解String Date Calendar之间的转换

    实例讲解String Date Calendar之间的转换

    下面小编就为大家带来一篇实例讲解String Date Calendar之间的转换。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-07-07
  • Spring Security中自定义cors配置及原理解析

    Spring Security中自定义cors配置及原理解析

    在Spring框架中,通过自定义CORS配置可根据实际情况调整URL的协议、主机、端口等,以适应"同源安全策略",配置原理涉及CorsConfigurer和CorsFilter,自定义配置需要注意@Configuration注解、方法名以及可能的@Autowired注解
    2024-10-10
  • SpringBoot整合微信登录功能的实现方案

    SpringBoot整合微信登录功能的实现方案

    今天通过本文给大家分享微信登录与SpringBoot整合过程,微信扫描登录实现代码知道扫描后点击登录的全部过程,本文给大家介绍的非常详细,需要的朋友可以参考下
    2021-10-10
  • java中实现excel合并单元格详细代码实例

    java中实现excel合并单元格详细代码实例

    最近的工作中,遇到一个需求在生成的Excel表格后需要在尾部添加一个合并的单元格数据,这篇文章主要给大家介绍了关于java中实现excel合并单元格的相关资料,需要的朋友可以参考下
    2024-06-06
  • SpringBoot声明式事务的简单运用说明

    SpringBoot声明式事务的简单运用说明

    这篇文章主要介绍了SpringBoot声明式事务的简单运用说明,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-09-09

最新评论