springboot3整合knife4j详细图文教程(swagger增强)

 更新时间:2024年03月11日 09:13:31   作者:LB_bei  
开发api提供对应的接口规范进行联调或并行开发,api文档管理必不可少,常用的Knife4j基于swagger(依赖已经compile),可以进行管理,下面这篇文章主要给大家介绍了关于springboot3整合knife4j的相关资料,需要的朋友可以参考下

前言

springboot升级到3后之前的knife4j配置就要变了一下了

1.导入依赖

<dependency>
        <groupId>com.github.xiaoymin</groupId>
        <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>

        <version>4.1.0</version>
</dependency>

2.创建配置文件

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class Knife4jConfig {

    @Bean
    public OpenAPI springShopOpenAPI() {
        return new OpenAPI()
                // 接口文档标题
                .info(
                        new Info().title("接口文档")
                        // 接口文档简介
                        .description("Knife4j OpenApi3的接口文档")
                        // 接口文档版本
                        .version("v1.0")
                        // 开发者联系方式
                        .contact(new Contact().name("").email(""))
                );
    }
}

3.controller上注解变了

@Tag(name = "首页")
public class HomeController {

controller方法上的注解 

@Operation(summary = "获取xxx")
public Result<xxx> getxxx(){

4.实体类应用的注解也变了

@Data
@Schema(name = "XXX")
public class XXXVO{

    @Id
    @Schema(description = "")
    private Integer id ;

    /** 父级id */
    @Schema(description = "父级id")
    private Integer pid ;
}

 总结

到此这篇关于springboot3整合knife4j的文章就介绍到这了,更多相关springboot3整合knife4j内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 浅谈Spring Boot日志框架实践

    浅谈Spring Boot日志框架实践

    这篇文章主要介绍了浅谈Spring Boot日志框架实践,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-03-03
  • Java正则环视和反向引用功能与用法详解

    Java正则环视和反向引用功能与用法详解

    这篇文章主要介绍了Java正则环视和反向引用功能与用法,结合实例形式较为详细的分析了java正则环视与反向引用的相关概念与使用方法,需要的朋友可以参考下
    2018-01-01
  • Java源码刨析之ArrayDeque

    Java源码刨析之ArrayDeque

    ArrayDeque是Deque接口的一个实现,使用了可变数组,所以没有容量上的限制。同时, ArrayDeque是线程不安全的,在没有外部同步的情况下,不能再多线程环境下使用<BR>
    2022-07-07
  • 解决JDK8的ParallelStream遍历无序的问题

    解决JDK8的ParallelStream遍历无序的问题

    这篇文章主要介绍了解决JDK8的ParallelStream遍历无序的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • Java对象存储内存布局详解

    Java对象存储内存布局详解

    众所周知,Java是一门面向对象的语言,那么一个对象在内存中都包含什么东西呢,本文主要详细介绍了Java对象的内存布局,访问定位,创建过程,线程安全,感兴趣的小伙伴可以跟着小编一起来学习
    2023-04-04
  • 浅谈解决Hibernate懒加载的4种方式

    浅谈解决Hibernate懒加载的4种方式

    这篇文章主要介绍了浅谈解决Hibernate懒加载的4种方式,具有一定借鉴价值,需要的朋友可以参考下。
    2017-12-12
  • Java阻塞队列必看类:BlockingQueue快速了解大体框架和实现思路

    Java阻塞队列必看类:BlockingQueue快速了解大体框架和实现思路

    这篇文章主要介绍了Java阻塞队列必看类:BlockingQueue快速了解大体框架和实现思路,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-10-10
  • Springboot整合Dubbo+Nacos实现RPC调用的示例代码

    Springboot整合Dubbo+Nacos实现RPC调用的示例代码

    随着互联网技术的飞速发展,越来越多的企业和开发者开始关注微服务架构,Nacos是阿里巴巴开源的一个动态服务发现、配置管理和服务管理平台,本文讲解如何将Spring Boot与Dubbo和Nacos整合,实现RPC调用,需要的朋友可以参考下
    2024-02-02
  • java同步开篇入门简单介绍

    java同步开篇入门简单介绍

    java中的CountDownLatch、Semaphore、CyclicBarrier这些类又不属于锁,它们和锁又有很多共同点,都是为了协同多线程的执行,都是一种同步器,所以这里就借用同步来取名字了,也就是“同步系列”的来源。下面小编来简单介绍下
    2019-05-05
  • Java基础-封装和继承

    Java基础-封装和继承

    这篇文章主要介绍了Java面向对象编程(封装/继承/多态)实例解析的相关内容,具有一定参考价值,需要的朋友可以了解下希望可以帮助到你
    2021-07-07

最新评论