Spring Boot 3 集成 Knife4j

已于 2023-12-07 21:31:08 修改
阅读量2.4k 收藏 24
点赞数 18
分类专栏： # SpringBoot 文章标签： spring boot 后端 java
于 2023-11-22 19:54:04 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/SUNBOYmxbsH/article/details/134553466
版权

基础环境

SpringBoot : 3.0.6
Java: jdk-17.0.5
Maven: 3.6.1

依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.0.6</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.giser</groupId>
    <artifactId>gis-java-mp</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>gis-java-mp</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>17</java.version>
    </properties>
    <dependencies>
		<!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-web -->
		<dependency>
		    <groupId>org.springframework.boot</groupId>
		    <artifactId>spring-boot-starter-web</artifactId>
		</dependency>

        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.3</version>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-jdbc</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

		<!-- 多数据源配置 -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
            <version>3.6.1</version>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-aop</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-jdbc</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        
		<!-- 代码自动生成 start -->
		<dependency>
		    <groupId>com.baomidou</groupId>
		    <artifactId>mybatis-plus-generator</artifactId>
		    <version>3.5.3</version>
		</dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
            <version>2.1.3.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.16</version>
        </dependency>
		<dependency>
		    <groupId>org.springframework.boot</groupId>
		    <artifactId>spring-boot-starter-freemarker</artifactId>
		    <version>3.1.5</version>
		</dependency>
		<!-- 代码自动生成 end -->
		
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.24</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
            <version>3.0.0</version>
        </dependency>
     
     	<!-- Spring Boot 3 集成 Knife4j start -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
        </dependency>
		<!-- Spring Boot 3 集成 Knife4j end -->
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.8.10</version>
        </dependency>
  <!-- 
        <dependency>
            <groupId>com.google.code.gson</groupId>
            <artifactId>gson</artifactId>
        </dependency>
    -->
    </dependencies>

    <repositories>
        <repository>
            <id>nexus-maven</id>
            <name>nexus-maven</name>
            <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
        </repository>
    </repositories>

	<!-- Spring Boot 3 集成 Knife4j start -->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>com.github.xiaoymin</groupId>
                <artifactId>knife4j-dependencies</artifactId>
                <version>4.3.0-SNAPSHOT</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
	<!-- Spring Boot 3 集成 Knife4j end -->
	
    <build>
        <finalName>gis-mp</finalName>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <mainClass>com.giser.mp.Knife4jSpringBoot3DemoApplication</mainClass>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

基础配置



server:
  port: 9999
  servlet:
    context-path: /
    encoding:
      charset: UTF-8
  
spring:
  datasource:
    params: useSSL=false&useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&allowMultiQueries=true&zeroDateTimeBehavior=convertToNull&allowMultiQueries=true&serverTimezone=GMT%2B8
    dynamic:
      primary: master
      strict: false
      datasource:
        master:
          url: jdbc:mysql://ip:port/db_name?${spring.datasource.params}
          username: db_user
          password: db_pwd
        slave:
          url: jdbc:mysql://ip:port/db_name?${spring.datasource.params}
          username: db_user
          password: db_pwd
      hikari:
        max-lifetime: 20000
        connection-timeout: 10000
        idle-timeout: 3000000
        min-idle: 4
        max-pool-size: 12
#
  servlet:
    multipart:
      max-file-size: 100MB
      max-request-size: 100MB
  application:
    name: gis-java-mp
springdoc:
  swagger-ui:
    path: /swagger-ui.html
    tags-sorter: alpha
    #operations-sorter: order
  api-docs:
    path: /v3/api-docs
  group-configs:
    - group: 'default'
      paths-to-match: '/**'
      # 生成接口文档的所需扫描的包路径
      packages-to-scan: com.giser.boot.knife4j
  default-flat-param-object: true

knife4j:
  enable: true
  setting:
    language: zh_cn
  basic:
    enable: false
    username: abc
    password: 123

使用

配置Swagger

package com.giser.mp.config;

import cn.hutool.core.util.RandomUtil;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springdoc.core.customizers.GlobalOpenApiCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.util.HashMap;
import java.util.Map;

@Configuration
public class SwaggerConfig {
    /**
     * 根据@Tag 上的排序，写入x-order
     *
     * @return the global open api customizer
     */
    @Bean
    public GlobalOpenApiCustomizer orderGlobalOpenApiCustomizer() {
        return openApi -> {
            if (openApi.getTags()!=null){
                openApi.getTags().forEach(tag -> {
                    Map<String,Object> map=new HashMap<>();
                    map.put("x-order", RandomUtil.randomInt(0,100));
                    tag.setExtensions(map);
                });
            }
            if(openApi.getPaths()!=null){
                openApi.addExtension("x-test123","333");
                openApi.getPaths().addExtension("x-abb",RandomUtil.randomInt(1,100));
            }

        };
    }

    @Bean
    public OpenAPI customOpenAPI() {
        return new OpenAPI()
                .info(new Info()
                        .title("XXX用户系统API")
                        .version("1.0")

                        .description( "Knife4j集成springdoc-openapi示例")
                        .termsOfService("http://doc.xiaominfo.com")
                        .license(new License().name("Apache 2.0")
                                .url("http://doc.xiaominfo.com")));
    }


}

启动注入

package com.giser.mp;

import java.net.InetAddress;
import java.net.UnknownHostException;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.core.env.Environment;

import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;

@Slf4j
@SpringBootApplication
@MapperScan("com.giser.mp.*.mapper")
public class Knife4jSpringBoot3DemoApplication {
	private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(Knife4jSpringBoot3DemoApplication.class);

    @SneakyThrows
    public static void main(String[] args) throws UnknownHostException {
        SpringApplication app=new SpringApplication(Knife4jSpringBoot3DemoApplication.class);
        ConfigurableApplicationContext application=app.run(args);
        //ConfigurableApplicationContext application=SpringApplication.run(Knife4jSpringBootDemoApplication.class, args);
        Environment env = application.getEnvironment();
        log.info("\n----------------------------------------------------------\n\t" +
                        "Application '{}' is running! Access URLs:\n\t" +
                        "Local: \t\thttp://localhost:{}\n\t" +
                        "External: \thttp://{}:{}\n\t"+
                        "Doc: \thttp://{}:{}/doc.html\n"+
                        "----------------------------------------------------------",
                env.getProperty("spring.application.name"),
                env.getProperty("server.port"),
                InetAddress.getLocalHost().getHostAddress(),
                env.getProperty("server.port"),
                InetAddress.getLocalHost().getHostAddress(),
                env.getProperty("server.port"));
    }

}

应用

package com.giser.mp.web;

import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import com.github.xiaoymin.knife4j.annotations.ApiOperationSupport;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.Parameters;
import io.swagger.v3.oas.annotations.enums.ParameterIn;
import io.swagger.v3.oas.annotations.tags.Tag;

@RestController
@RequestMapping("/api/demo/")
@Tag(name = "接口文档示例")
public class Body1Controller {

    @Operation(summary = "GET")
    @ApiOperationSupport(order = 10)
    @GetMapping("/user/{id}")
    public ResponseEntity<String> getDemo(@PathVariable("id") String id){
        return ResponseEntity.ok(null);
    }

    @Operation(summary = "POST")
    @ApiOperationSupport(order = 1)
    @PostMapping("/m1")
    public ResponseEntity<String> postDemo(@RequestBody String request){
        return ResponseEntity.ok(request);
    }
    
    @Operation(summary = "PUT")
    @ApiOperationSupport(order = 2)
    @PutMapping("/m12")
    public ResponseEntity<String> putDemo(@PathVariable("id") String id){
        return ResponseEntity.ok(id);
    }
    
    @Operation(summary = "DELETE")
    @ApiOperationSupport(order = 2)
    @DeleteMapping("/user/{id}")
    public ResponseEntity<String> deleteDemo(@PathVariable("id") String id){
        return ResponseEntity.ok(id);
    }
    
    @Operation(summary = "普通body请求")
    @PostMapping("/body")
    public ResponseEntity<Object> body(@RequestBody Object fileResp){
        return ResponseEntity.ok(fileResp);
    }

    @Operation(summary = "普通body请求+Param+Header+Path")
    @Parameters({
            @Parameter(name = "id",description = "文件id",in = ParameterIn.PATH),
            @Parameter(name = "token",description = "请求token",required = true,in = ParameterIn.HEADER),
            @Parameter(name = "name",description = "文件名称",required = true,in=ParameterIn.QUERY)
    })
    @PostMapping("/bodyParamHeaderPath/{id}")
    public ResponseEntity<Object> bodyParamHeaderPath(@PathVariable("id") String id,@RequestHeader("token") String token, @RequestParam("name")String name,@RequestBody Object fileResp){
        return ResponseEntity.ok(fileResp);
    }

}

参考 Knife4j

黄晶谛
关注
  • 18
    点赞
  • 踩
  • 24
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Spring Boot 框架 集成 Knife4（源代码）
02-22
Spring Boot 框架 集成 Knife4（源代码） Spring Boot 框架 集成 Knife4j 零、创建一个SpringBoot项目 一、pom.xml导入Knife4j的依赖 二、创建Knife4j的配置类 三、application.yml配置文件 四、Controller层 五、运行启动类，访问并测试
Knife4j各版本集成SpringBoot 2.x 3.x版本demo示例
04-23
Knife4j各版本集成SpringBoot 2.x 3.x版本demo示例，亲测可用 ，仅供学习使用。
Spring Boot3整合knife4j(swagger3)
蒾酒的博客
01-23 4308
Knife4j · 集Swagger2及OpenAPI3为一体的增强解决方案. | Knife4j (xiaominfo.com)作者的使用的spring boot 3.2.2为当前最新版，所以依赖导入最新的knife4j 4.4.0。3.1 增强模式 | Knife4j (xiaominfo.com)好一个spring boot项目且版本为3X，项目可正常启动。快速开始 | Knife4j (xiaominfo.com)接下来配置以下接口文档的作者等信息。@Tag注解：标记接口类别。
基于springboot3基本使用knife4j-openapi3-jakarta-spring-boot-starter
最新发布
qq_74947724的博客
05-21 1031
基于springboot使用knife4j完成简单、方便的OpenAPI接口文档开发
Spring Boot整合Swagger3.0及Knife4j
cristianoxm的博客
12-15 5989
Swagger是一组围绕 OpenAPI 规范构建的开源工具，可帮助您设计、构建、记录和使用 REST API。主要的 Swagger 工具包括：Swagger Editor – 基于浏览器的编辑器，您可以在其中编写 OpenAPI 规范。Swagger UI – 将 OpenAPI规范呈现为交互式 API 文档。swagger2于17年停止维护，现在最新的版本为 Swagger3（Open Api3）。knife4j是。
springboot3整合knife4j（swagger增强）
LB_bei的博客
01-15 1213
springboot升级到3后之前的knife4j配置就要变了一下了。
springBoo3.0集成knife4j4.1.0（swagger3）
qq_45001053的博客
03-31 5870
springBoot3.0集成swagger3的过程步骤
Springboot3.0.0+集成SpringDoc并配置knife4j的UI
Anakki的博客
08-17 3417
环境：JDK17,Springboot3+,springdoc2+,knife4j 4+Springdoc本身也是集成了Swagger3，而knife4j美化了Swagger3的UI由于此knife4j内依赖了SpringDoc，因此不用另外引入springdoc的依赖springdoc依赖（无需引入），亲测引入也不会冲突。
spring boot 集成swagger+knife4j，集成mybatis-plus和代码生成器
10-28
spring boot快速上手示例，集成了swagger+knife4j接口文档，集成mybatis-plus持久化，统一的数据返回封装，集成mybatis-plus-generator代码生成器，加入了lombok框架，一个完成的sping boot 示例项目，简单易上手
Knife4j官网（源代码）
02-21
7.1.3 Spring Boot 框架集成Knife4j Knife4j是一个集Swagger2 和 OpenAPI3为一体的增强解决方案 帮助开发者快速聚合使用OpenAPI规范. 基础特性 兼容OpenAPI 2.0 兼容OpenAPI 3.0 框架适配 适配兼容Spring MVC ...
knife4j-aggregation-spring-boot-starter-2.0.8.jar
02-21
Knife4j是为Java MVC框架集成化Swagger形成Api文本文档的增强解决方法，原名swagger-bootstrap-ui，取名字kni4j是期待她能像一把短刀一样精巧、轻巧、而且作用强大！【软件详细介绍】Knife4j的原名是swagger-...
springboot3 集成knife4j
一个写了10年bug的程序员日常笔记。
04-22 1318
Knife4j是一个集Swagger2 和 OpenAPI3为一体的增强解决方案。Knife4j · 集Swagger2及OpenAPI3为一体的增强解决方案. | Knife4jjava：17。
SpringBoot 集成 Swagger 3.0 和 knife4j 文档教程
shijialeya
02-28 1369
SpringBoot 集成 Swagger 3.0 和 knife4j 文档教程
SpringBoot3中Swagger整合knife4j和springdoc的配置说明
m0_74055560的博客
11-11 6422
springboot3开始javax包改成了jakarta，而swagger-oas等包中依然使用的是javax所以报错。另外springfox已经过时了，两年没更新了，并且不支持OpenAPI3 标准，而SpringBoot3只支持OpenAPI3规范，所以要迁移到springdocKnife4J是一款基于Swagger快速生成API文档和调试平台的开源工具，它可以轻松地将Swagger规范转换成易于阅读的文档，并支持在线测试API。
Knife4j在springboot3中如何集成呢（如果大家阅读能力好的话，建议直接看作者写的博客。当然，在下面也会附上作者的博客）
m0_56350559的博客
11-13 278
springboot3集成knife4j
Sping Boot3整合knife4j接口文档
m0_61364659的博客
03-21 696
请求参数响应参数接口地址接口名称请求类型请求格式备注API文档生成：可以根据Controller和方法上的注解自动生成Markdown格式的API文档在线访问API：可以在knife4j的页面直接访问我们的API接口Token管理：可以在knife4j中对API Token进行管理比较请求与响应：可以比较同一个API的请求与响应内容的差异高亮API响应：将API响应中的JSON高亮显示，方便查看..
SpringBoot整合knife4j
2301_79336341的博客
01-04 651
这里还有一个注意事项就是，用继承WebMvcConfigurationSupport方法的时候千万不能加@EnableWebMVC这个注解，因为我们是用继承的方法所以用该注解的时候他加载的是他本身的实现的内容，而我们自定义的静态文件就都不会加载。或者是直接WebConfig类直接实现WebMvcConfigurer的情况下才能加这个注解。第三步：加载静态文件，以及配置了拦截器，放行路径。第四步：新建一个接口Controller类，如下。
SpringBoot整合Swagger3和Knife4j及使用
长臂人猿的博客
08-09 2039
开发api提供对应的接口规范进行联调或并行开发，api文档管理必不可少。常用的Knife4j基于swagger（依赖已经compile），可以进行管理。
SpringBoot3+支持Knife4j 4.0以上
qq_73440769的博客
03-26 1559
定义一个配置类WebMvcConfiguration，实现静态资源映射，保证生成的接口文档能够正常进行展示/*** 配置类，注册web层相关组件*/@Slf4j/*** 设置静态资源映射*/log.info("开始设置静态资源映射...");
spring boot 如何集成knife4j-swagger
06-02
要在Spring Boot中集成knife4j-swagger，可以按照以下步骤进行操作： 1.添加依赖 在 `pom.xml` 文件中添加以下依赖： ``` <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>3.0.2</version> </dependency> ``` 2.配置Knife4j 在 `application.yml` 或 `application.properties` 文件中添加以下配置： ``` # Swagger配置 swagger: title: API接口文档 description: API接口文档 version: 1.0.0 license: Apache License 2.0 license-url: http://www.apache.org/licenses/LICENSE-2.0.html contact-name: xxx contact-url: xxx contact-email: xxx ``` 3.编写API接口 在Controller类中添加API接口，并且在方法上添加Swagger相关注解。比如： ``` @RestController @Api(tags = "用户管理") @RequestMapping("/user") public class UserController { @ApiOperation(value = "获取用户列表", notes = "获取所有用户的列表") @GetMapping("/list") public List<User> list() { // 返回用户列表 } @ApiOperation(value = "创建用户", notes = "根据User对象创建用户") @PostMapping("/create") public void create(@RequestBody User user) { // 创建用户 } } ``` 4.启动应用程序 在启动应用程序后，访问 `http://localhost:port/doc.html` 即可查看API文档。 以上就是在Spring Boot中集成knife4j-swagger的步骤。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值