SpringBoot与knife4j的整合使用过程

 更新时间:2024年08月12日 14:48:04   作者:小小李程序员  
Knife4j 是一个基于Swagger构建的开源 JavaAPI文档工具,主要包括两大核心功能:文档说明和在线调试,这篇文章主要介绍了SpringBoot与knife4j的整合使用,需要的朋友可以参考下

在网上看了一堆 knife4j 的使用教程,很多都是报一堆错误,经过千方百次的尝试,终于找到了合适的版本及其配置

版本

此处是 knife4j2.0.7 版本 SpringBoot2.3.5.RELEASE 版本 

  其他版本推荐

        Spring Boot版本       Knife4j Swagger2规范
         1.5.x ~ 2.0.0     <Knife4j 2.0.0
         2.0 ~ 2.2     Knife4j 2.0.0 ~ 2.0.6
         2.2.x~2.4.0    Knife4j 2.0.6 ~ 2.0.9
          2.4.0~2.7.x     >=Knife4j 4.0.0
          >= 3.0     >=Knife4j 4.0.0

导入maven坐标

<!-- 导入knife4j2.0.7版本依赖  SpringBoot2.3.5.RELEASE 版本	-->
<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>knife4j-spring-boot-starter</artifactId>
   <version>2.0.7</version>
</dependency>

  另外SpringBoot2.3.2.RELEASE ~ SpringBoot2.5.15版本与Knife4j2.0.7 ~ Knife4j3.0.3整合SpringBoot的起步依赖也是兼容的

编写配置类

  目录结构如下:

 配置类:

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;
@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {
    // Student组的测试文档
    @Bean(value = "studentDocket")
    public Docket studentDocket() {
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .title("测试学生端接口文档")		// 设置当前文档的标题
                        .description("用于测试学生端的所有接口的文档")		//自定义文档简介
                        .termsOfServiceUrl("写学生端人员的服务地址URL")	//写这个模块功能的程序员相关的URL
                        .contact("写学生端人员的联系方式(邮箱)")		//写这个模块功能的程序员的email邮箱
                        .version("1.0")	//指定当前文档的版本
                        .build())
                //分组名称
                .groupName("学生端")		//设置当前组名称
                .select()
                //这里指定Controller扫描包路径,"com.example.controller.student"是一个放Controller的包
                .apis(RequestHandlerSelectors.basePackage("com.example.controller.student"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
	// Teacher组的测试文档
    @Bean(value = "teacherDocket")
    public Docket teacherDocket() {
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .title("测试教师端接口文档")
                        .description("用于测试教师端的所有接口的文档")
                        .termsOfServiceUrl("写教师端人员的服务地址URL")
                        .contact("写教师端人员的联系方式(邮箱)")
                        .version("1.0")
                        .build())
                //分组名称
                .groupName("教师端")
                .select()
                //这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.example.controller.teacher"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
}

 StudentController学生控制层

TeacherController教师控制层

注解说明:

    @Api :可以通过tags属性描述当前控制层的相关信息

    @ApiOperation:可以通过value属性描述当前接口的功能

页面效果

  访问地址:http://localhost:8080/doc.html (我的端口是8080,如果你修改了程序启动端口,记得换成自己的端口)         

学生端

 教师端

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

相关文章

  • SpringBoot任意版本集成Swagger各种版本的操作指南

    SpringBoot任意版本集成Swagger各种版本的操作指南

    在学习Swagger生成API文档的时候经常会遇到问题,而目前市面上大部分技术分享者的SpringBoot版本并没和我们的同步,导致一些一模一样的代码,在我们的项目上却无法使用,这是一个经常性的问题,本文章就旨在和大家搞定SpringBoot任意版本集成Swagger各种版本
    2024-07-07
  • java向上转型与向下转型详解

    java向上转型与向下转型详解

    这篇文章主要为大家详细介绍了java向上转型与向下转型,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-09-09
  • JAVA工程中引用本地jar的3种常用简单方式

    JAVA工程中引用本地jar的3种常用简单方式

    Jar文件的全称是Java Archive File即Java归档文件,主要是对class文件进行压缩,是一种压缩文件,和常见的zip压缩文件兼容,下面这篇文章主要给大家介绍了关于JAVA工程中引用本地jar的3种常用简单方式,需要的朋友可以参考下
    2024-03-03
  • Java中Comparable接口和Comparator接口的使用比较

    Java中Comparable接口和Comparator接口的使用比较

    Java中提供了两种对集合或数组中元素进行排序的方法,一种是实现Comparable接口,另一种是实现Comparator接口,下面这篇文章主要给大家介绍了关于Java中Comparable接口和Comparator接口使用的相关资料,需要的朋友可以参考下
    2024-06-06
  • 基于Java Springboot + Vue + MyBatis实现音乐播放系统

    基于Java Springboot + Vue + MyBatis实现音乐播放系统

    这篇文章主要介绍了一个完整的音乐播放系统是基于Java Springboot + Vue + MyBatis编写的,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-08-08
  • Java之打印String对象的地址

    Java之打印String对象的地址

    这篇文章主要介绍了Java之打印String对象的地址,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-09-09
  • 两个jar包下相同包名类名引入冲突的解决方法

    两个jar包下相同包名类名引入冲突的解决方法

    本文主要介绍了两个jar包下相同包名类名引入冲突的解决方法,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-02-02
  • Java File类常用方法与文件过滤器详解

    Java File类常用方法与文件过滤器详解

    Java File类以抽象的方式代表文件名和目录路径名。该类主要用于文件和目录的创建、文件的查找和文件的删除等。File对象代表磁盘中实际存在的文件和目录。本篇文章我们来讲解File类的常用方法与文件过滤器
    2022-04-04
  • 利用Java搭建个简单的Netty通信实例教程

    利用Java搭建个简单的Netty通信实例教程

    这篇文章主要给大家介绍了关于如何利用Java搭建个简单的Netty通信,文中通过示例代码介绍的非常详细,对大家学习或者使用Java具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧
    2020-05-05
  • java中的JSONP使用实例详解

    java中的JSONP使用实例详解

    json和JSONP这二者在开发中还是很常见的,本文重点给大家介绍下java中的jsonp使用实例详解,需要的朋友参考下
    2017-04-04

最新评论