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内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

Spring Boot整合阿里开源中间件Canal实现数据增量同步
这篇文章主要为大家介绍了Spring Boot整合阿里开源中间件Canal实现数据增量同步示例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-06-06
基于Jpa中ManyToMany和OneToMany的双向控制
这篇文章主要介绍了Jpa中ManyToMany和OneToMany的双向控制，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-12-12
浅谈JAVA设计模式之代理模式
这篇文章主要介绍了JAVA设计模式之代理模式的的相关资料，文中代码非常详细，供大家参考和学习，感兴趣的朋友可以了解下
2020-06-06
MyBatis的⾼级映射及延迟加载过程详解
这篇文章主要介绍了MyBatis的⾼级映射及延迟加载,包括多对一延时加载方式及一对多，本文结合实例代码给大家介绍的非常详细，需要的朋友可以参考下
2023-02-02
SpringSecurity的TokenStore四种实现方式小结
本文主要介绍了SpringSecurity的TokenStore四种实现方式小结,分别是InMemoryTokenStore,JdbcTokenStore,JwkTokenStore,RedisTokenStore,具有一定的参考价值,感兴趣的可以了解一下
2024-01-01
SpringBoot启动过程逐步分析讲解
这篇文章主要介绍了SpringBoot启动过程的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习吧
2023-01-01
解析整合mybatis-spring需要的maven依赖配置问题
这篇文章主要介绍了整合mybatis-spring需要的maven依赖配置问题，创建Maven项目，导入相关jar包，文中还给大家提到了，解决maven静态资源约定大于习惯问题,本文给大家介绍的非常详细，需要的朋友参考下吧
2021-11-11
使用stream的Collectors.toMap()方法常见的问题及解决
这篇文章主要介绍了使用stream的Collectors.toMap()方法常见的问题及解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-03-03
Java类锁、对象锁、私有锁冲突测试
这篇文章主要介绍了Java类锁、对象锁、私有锁冲突测试,得出结论是加锁方法够成了竞争关系,同一时刻只能有一个方法能执行,需要的朋友可以参考下
2014-10-10
IDEA最新激活码2021(IDEA2020.3.2最新永久激活方法)
这篇文章主要介绍了IDEA最新激活码2021(IDEA2020.3.2最新永久激活方法),本文通过实例图文相结合给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2020-12-12