Springboot整合Knife4j接口文档

Springboot整合Knife4j接口文档

  • 一、knife4j是什么
  • 二、快速开始
    • 1.Spring Boot 3版本
      • 1.引入依赖
      • 2.yml配置:
      • 3.示例代码
    • 2.Spring Boot 3版本
      • 1.引入依赖
      • 2.yml配置
      • 3.4. 注解使用

一、knife4j是什么

Knife4j是一个基于SpringBoot构建的文档生成工具,旨在为Java MVC框架集Swagger2 和 OpenAPI3为一体的增强解决方案。**

二、快速开始

1.Spring Boot 3版本

  • Spring Boot 3 只支持OpenAPI3规范
  • Knife4j提供的starter已经引用springdoc-openapi的jar,开发者需注意避免jar包冲突
  • JDK版本必须 >= 17
  • 详细Demo请参考knife4j-spring-boot3-demo

1.引入依赖

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

2.yml配置:

# springdoc-openapi项目配置
springdoc:swagger-ui:path: /swagger-ui.htmltags-sorter: alphaoperations-sorter: alphaapi-docs:path: /v3/api-docsgroup-configs:- group: 'default'paths-to-match: '/**'packages-to-scan: com.xiaominfo.knife4j.demo.web
# knife4j的增强配置,不需要增强可以不配
knife4j:enable: truesetting:language: zh_cn

3.示例代码

@RestController
@RequestMapping("body")
@Tag(name = "body参数")
public class BodyController {@Operation(summary = "普通body请求")@PostMapping("/body")public ResponseEntity<FileResp> body(@RequestBody FileResp 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<FileResp> bodyParamHeaderPath(@PathVariable("id") String id,@RequestHeader("token") String token, @RequestParam("name")String name,@RequestBody FileResp fileResp){fileResp.setName(fileResp.getName()+",receiveName:"+name+",token:"+token+",pathID:"+id);return ResponseEntity.ok(fileResp);}
}

最后,访问Knife4j的文档地址:http://ip:port/doc.html即可查看文档

2.Spring Boot 3版本

  • Spring Boot 版本建议 2.4.0~3.0.0之间
  • Spring Boot 版本 < 2.4 版本则建议选择Knife4j 4.0之前的版本
  • Spring Boot 2 + OpenAPI2 demo:knife4j-spring-boot27-demo
  • Spring Boot 2 + OpenAPI3 demo:knife4j-springdoc-openapi-demo

1.引入依赖

<dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-openapi2-spring-boot-starter</artifactId><version>4.4.0</version>
</dependency>

2.yml配置

knife4j:enable: trueopenapi:title: Knife4j官方文档description: "`我是测试`,**你知道吗**# aaa"email: xiaoymin@foxmail.comconcat: 八一菜刀url: https://docs.xiaominfo.comversion: v4.0license: Apache 2.0license-url: https://stackoverflow.com/terms-of-service-url: https://stackoverflow.com/group:test1:group-name: 分组名称api-rule: packageapi-rule-resources:- com.knife4j.demo.new3

3.4. 注解使用

@Api(tags = “01.用户管理模块”)

@Api标注在Controller类上,在页面上接口文档页面上会分类替代Controller名称

@ApiOperation(value=“查询列表”)

@ApiOperation标注在Controller方法上,在接口文档页面会显示value内容替代方法名

@ApiModelProperty(value = “用户名”, required = true, example = “赵丽颖”)

@ApiModelProperty标注在入参的dto变量上,value会替代具体参数名称,required会显示是否必填项,example会给出默认值

@ApiImplicitParam(name = “id”, value = “微博”, required=true, dataType = “int”)

@ApiImplicitParam标注在Controller方法上,对未封装参数进行注释,value会替代具体参数名称,required会显示是否必填项,dataType 指定参数类型

@ApiIgnore

@ApiIgnore标注在Controller方法的入参上,被标注的参数表示忽略该参数,不会在接口文档中显示,例如HttpRequest参数不需要显示。

最后,访问Knife4j的文档地址:http://ip:port/doc.html即可查看文档

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/850020.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

web前端考核:全面解读与深入剖析

web前端考核&#xff1a;全面解读与深入剖析 在数字化浪潮席卷全球的今天&#xff0c;Web前端技术已成为互联网行业的核心驱动力之一。对于Web前端开发者而言&#xff0c;如何全面、深入地掌握这一领域的知识与技能&#xff0c;并通过考核验证自己的实力&#xff0c;是每位从业…

Java | Leetcode Java题解之第137题只出现一次的数字II

题目&#xff1a; 题解&#xff1a; class Solution {public int singleNumber(int[] nums) {int a 0, b 0;for (int num : nums) {b ~a & (b ^ num);a ~b & (a ^ num);}return b;} }

什么是 with dice coefficients(Dice系数)

记录一下 什么是 with dice coeffcients?&#xff08;本帖子不是专业的&#xff0c;只是在审稿的时候遇见了 所以就顺手查找一下并记录下来&#xff09; Dice系数和mIoU是语义分割的评价指标。   With Dice coefficients&#xff08;Dice系数&#xff09;是一种用于评估两个…

Linux 命令:iotop

1. 写在前面 本文主要介绍 Linux iotop 或 Input/Output top 命令&#xff1a;用于显示和监控磁盘 IO 使用详情&#xff0c;甚至获取进程现有 IO 使用情况。它是用 python 设计的&#xff0c;需要内核模块才能执行。系统管理员可以用它来追踪可能导致磁盘 I/O 读写量过高的特定…

vite+vue+ts项目中报错解决方案

1.vitevue3ts项目中提示无法找到模块 一&#xff0e;首先产生这个错误是&#xff1a;无法找到模块XXX&#xff0c;并且提示XXX is declared but its value is never read 二&#xff0e; 产生这个问题的原因是我们使用了ts语法&#xff0c;他只能识别.ts文件&#xff0c;并不…

4、js数据类型,检测数据类型

一、js数据类型 基本&#xff08;简单、原始&#xff09;数据类型&#xff1a;number/string/boolean/undefined/null/symbol/bigint引用&#xff08;复杂&#xff09;数组类型&#xff1a;object&#xff08;function,array&#xff0c;date&#xff09; 1、symbol是什么&…

javaweb学习(day14-ThreadLocal文件上传下载)

一、线程数据共享和安全 -ThreadLocal 1 什么是 ThreadLocal ThreadLocal 的作用&#xff0c;可以实现在同一个线程数据共享, 从而解决多线程数据安全问题. ThreadLocal 可以给当前线程关联一个数据(普通变量、对象、数组)set 方法 [源码!] ThreadLocal 可以像 Map 一样存取数…

[知识点]c++运算符重载

在 C 中&#xff0c;运算符重载&#xff08;Operator Overloading&#xff09;允许你定义或修改运算符的行为&#xff0c;使其适用于用户定义的类型&#xff08;例如类或结构体&#xff09;。通过运算符重载&#xff0c;你可以使自定义类型与内置类型一样自然地使用运算符。 重…

大模型的 Embedding 模型该如何进行微调?

节前&#xff0c;我们星球组织了一场算法岗技术&面试讨论会&#xff0c;邀请了一些互联网大厂朋友、参加社招和校招面试的同学. 针对算法岗技术趋势、大模型落地项目经验分享、新手如何入门算法岗、该如何准备、面试常考点分享等热门话题进行了深入的讨论。 汇总合集&…

Vue的基础知识:v-model的原理,由:value与@input合写。

原理&#xff1a;v-model本质上是一个语法糖&#xff0c;比如应用在输入框上&#xff0c;就是value属性和input事件的合写。&#xff08;补充说明&#xff1a;语法糖就是语法的简写&#xff09; 作用&#xff1a;提供数据的双向绑定 1.数据变&#xff0c;视图&#xff08;也就…

[数据集][目标检测]叶子计数检测数据集VOC+YOLO格式240张1类别

数据集格式&#xff1a;Pascal VOC格式YOLO格式(不包含分割路径的txt文件&#xff0c;仅仅包含jpg图片以及对应的VOC格式xml文件和yolo格式txt文件) 图片数量(jpg文件个数)&#xff1a;240 标注数量(xml文件个数)&#xff1a;240 标注数量(txt文件个数)&#xff1a;240 标注类别…

2024年谷歌SEO如何快速出排名效果抢占首页制高点?

2024年&#xff0c;随着谷歌搜索引擎算法的不断更新&#xff0c;SEO策略也需要与时俱进才能快速出排名。本文将结合谷歌最新SEO趋势&#xff0c;平哥SEO分享一些实操性的快速排名技巧&#xff0c;帮助你在竞争激烈的搜索结果中脱颖而出。 额外话题&#xff1a;就是通过微信公众…

break、continue、return

break 程序示例&#xff1a; // 产生一个位于 [1, 100] 范围内的随机数&#xff0c;统计产生 100 所需要的次数 public static void main(String[] args) {// System.out.println(Math.random()); // [0,1)// System.out.println(Math.random() * 100); // [0,100)// Syste…

什么是XSS攻击?什么是SQL注入攻击?什么是CSRF攻击?

XSS攻击、SQL注入攻击和CSRF攻击是三种常见的网络安全威胁&#xff0c;它们分别针对不同的应用层面和安全漏洞。以下是对这三种攻击方式的详细介绍&#xff1a; 1. XSS攻击&#xff08;跨站脚本攻击&#xff0c;Cross-Site Scripting&#xff09; 业务场景&#xff1a; 用户…

Java Web学习笔记25——Vue组件库Element

什么是Element&#xff1f; Element: 是饿了么团队研发的&#xff0c;一套为开发者、设计师和产品经理准备的基于Vue2.0的桌面端组件库。 组件&#xff1a;组成网页的部件&#xff0c;例如&#xff1a;超链接、按钮、图片、表格、表单、分页条等等。 官网&#xff1a;https:…

C++设计模式---工厂模式

C中工厂模式是一种创建型设计模式&#xff0c;它允许客户端代码通过调用工厂方法来创建对象&#xff0c;而无需直接使用new运算符实例化具体类。这种模式有助于将类的创建与使用相分离&#xff0c;并且在需要添加新的具体类时可以减少对客户端代码的影响。 工厂模式通常有两种实…

深拷贝、浅拷贝、引用拷贝

深拷贝和浅拷贝的区别 1. 引用拷贝2. 对象拷贝 1. 引用拷贝 两个对象指向同一个地址值。 创建一个指向对象的引用变量的拷贝Teacher teacher new Teacher("Taylor",26); Teacher otherteacher teacher; System.out.println(teacher); System.out.println(otherte…

cocos入门8:向量叉乘

在cocos creator中&#xff0c;向量叉乘&#xff08;Cross Product&#xff09;是一个重要的概念&#xff0c;主要用于3D图形学中的方向计算和法线计算。叉乘的结果是一个垂直于两个输入向量的新向量&#xff0c;其长度等于输入向量围成的平行四边形的面积。以下是对向量叉乘的…

前端多人项目开发中,如何保证CSS样式不冲突?

在前端项目开发中&#xff0c;例如突然来了一个大项目&#xff0c;很可能就需要多人一起开发&#xff0c;领导说了&#xff0c;要快&#xff0c;要快&#xff0c;要快&#xff0c;你们给我快。然后下面大伙就一拥而上&#xff0c;干着干着发现&#xff0c;一更新代码&#xff0…

【AI论文与新生技术】Follow-Your-Emoji:精细可控且富有表现力的自由式人像动画技术

我们提出了 Follow-Your-Emoji&#xff0c;这是一种基于扩散的肖像动画框架&#xff0c;它使用目标地标序列对参考肖像进行动画处理。肖像动画的主要挑战是保留参考肖像的身份并将目标表情转移到该肖像&#xff0c;同时保持时间一致性和保真度。为了应对这些挑战&#xff0c;Fo…