springboot3整合knife4j详细版，包会！（不带swagger2玩）

1. 引入依赖

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

2. 配置文件

简短必要版
# 配置springdoc-openapi，用于文档化和访问API
springdoc:
  # 配置Swagger UI的访问路径和排序方式
  swagger-ui:
    path: /swagger-ui.html  # Swagger UI的访问路径
    tags-sorter: alpha      # 按字母顺序排序标签
    operations-sorter: alpha  # 按字母顺序排序操作
  # 配置API文档的访问路径
  api-docs:
    path: /v3/api-docs  # API文档的访问路径
  # 配置API分组，用于组织和管理API
  group-configs:
    - group: 'default'   # API分组名称
      paths-to-match: '/**'  # 匹配所有路径
      packages-to-scan: com.ykx.easyexceldemo02.controller  # 扫描的包，用于自动发现API

# knife4j的增强配置，不需要增强可以不配（详细版见下小节）
knife4j:
  enable: true
  setting:
    language: zh_cn
详细全部版
# 配置Knife4j，以启用Swagger文档的增强功能和定制化展示
knife4j:
  # 启用Knife4j扩展
  enable: true
  # 配置展示的文档分组
  documents:
    - 
      # 文档分组标题
      group: 2.X版本
      # 文档分组描述
      name: 接口签名
      # 指定接口文档的位置
      locations: classpath:sign/*
  # 配置Knife4j的展示细节和功能开关
  setting:
    # 设置界面语言
    language: zh-CN
    # 启用Swagger模型展示
    enable-swagger-models: true
    # 启用文档管理功能
    enable-document-manage: true
    # 设置Swagger模型的显示名称
    swagger-model-name: 实体类列表
    # 是否显示版本信息
    enable-version: false
    # 是否启用参数缓存刷新
    enable-reload-cache-parameter: false
    # 启用后端脚本支持
    enable-after-script: true
    # 过滤特定方法类型的multipart/form-data接口
    enable-filter-multipart-api-method-type: POST
    # 是否过滤所有multipart/form-data类型的接口
    enable-filter-multipart-apis: false
    # 启用请求缓存
    enable-request-cache: true
    # 是否显示自定义主机名
    enable-host: false
    # 设置自定义的主机名
    enable-host-text: 192.168.0.193:8000
    # 启用自定义首页
    enable-home-custom: true
    # 设置自定义首页的路径
    home-custom-path: classpath:markdown/home.md
    # 是否启用搜索功能
    enable-search: false
    # 是否显示页脚
    enable-footer: false
    # 启用自定义页脚内容
    enable-footer-custom: true
    # 设置自定义页脚的内容
    footer-custom-content: Apache License 2.0 | Copyright 2019-[浙江八一菜刀股份有限公司](https://gitee.com/xiaoym/knife4j)
    # 是否启用动态参数
    enable-dynamic-parameter: false
    # 启用调试模式
    enable-debug: true
    # 启用OpenAPI 3.0的支持
    enable-open-api: false
    # 启用接口分组功能
    enable-group: true
  # 是否启用CORS跨域支持
  cors: false
  # 是否启用生产模式
  production: false
  # 配置基本的认证信息
  basic:
    # 启用基本认证
    enable: false
    # 设置用户名
    username: test
    # 设置密码
    password: 12313

注意：要使用Knife4j提供的增强，knife4j.enable=true必须开启

各个配置属性说明如下：

属性

默认值

说明值

knife4j.enable

false

是否开启Knife4j增强模式

knife4j.cors

false

是否开启一个默认的跨域配置,该功能配合自定义Host使用

knife4j.production

false

是否开启生产环境保护策略,详情参考文档

knife4j.basic

对Knife4j提供的资源提供BasicHttp校验,保护文档

knife4j.basic.enable

false

关闭BasicHttp功能

knife4j.basic.username

basic用户名

knife4j.basic.password

basic密码

knife4j.documents

自定义文档集合，该属性是数组

knife4j.documents.group

所属分组

knife4j.documents.name

类似于接口中的tag,对于自定义文档的分组

knife4j.documents.locations

markdown文件路径,可以是一个文件夹(classpath:markdowns/*)，也可以是单个文件(classpath:md/sign.md)

knife4j.setting

前端Ui的个性化配置属性

knife4j.setting.enable-after-script

true

调试Tab是否显示AfterScript功能,默认开启

knife4j.setting.language

zh-CN

Ui默认显示语言,目前主要有两种:中文(zh-CN)、英文(en-US)

knife4j.setting.enable-swagger-models

true

是否显示界面中SwaggerModel功能

knife4j.setting.swagger-model-name

Swagger Models

重命名SwaggerModel名称,默认

knife4j.setting.enable-document-manage

true

是否显示界面中"文档管理"功能

knife4j.setting.enable-reload-cache-parameter

false

是否在每个Debug调试栏后显示刷新变量按钮,默认不显示

knife4j.setting.enable-version

false

是否开启界面中对某接口的版本控制,如果开启，后端变化后Ui界面会存在小蓝点

knife4j.setting.enable-request-cache

true

是否开启请求参数缓存

knife4j.setting.enable-filter-multipart-apis

false

针对RequestMapping的接口请求类型,在不指定参数类型的情况下,如果不过滤,默认会显示7个类型的接口地址参数,如果开启此配置,默认展示一个Post类型的接口地址

knife4j.setting.enable-filter-multipart-api-method-type

POST

具体接口的过滤类型

knife4j.setting.enable-host

false

是否启用Host

knife4j.setting.enable-host-text

false

HOST地址

knife4j.setting.enable-home-custom

false

是否开启自定义主页内容

knife4j.setting.home-custom-path

主页内容Markdown文件路径

knife4j.setting.enable-search

false

是否禁用Ui界面中的搜索框

knife4j.setting.enable-footer

true

是否显示Footer

knife4j.setting.enable-footer-custom

false

是否开启自定义Footer

knife4j.setting.footer-custom-content

false

自定义Footer内容

knife4j.setting.enable-dynamic-parameter

false

是否开启动态参数调试功能

knife4j.setting.enable-debug

true

启用调试

knife4j.setting.enable-open-api

true

显示OpenAPI规范

knife4j.setting.enable-group

true

显示服务分组

3. 常用注解

1. 类级别注解
@Operation

用于描述控制器类中的单个操作。

@Operation(summary = "获取用户列表", description = "返回所有用户的列表")
@GetMapping("/users")
public List<User> getUsers() {
    // ...
}

属性：

  • summary：简短描述。
  • description：详细说明。
  • tags：标签，用于分类API。
  • responses：响应描述。
@Tag

用于为API操作分组。

@Tag(name = "用户管理", description = "用户相关操作")
@RestController
@RequestMapping("/users")
public class UserController {
    // ...
}

属性：

  • name：标签名。
  • description：标签描述。
2. 方法级别注解
@Operation

用于描述单个操作，类似于类级别使用方式。

@Operation(summary = "获取用户列表", description = "返回所有用户的列表")
@GetMapping("/users")
public List<User> getUsers() {
    // ...
}

属性：

  • summary：简短描述。
  • description：详细说明。
  • tags：标签，用于分类API。
  • responses：响应描述。
@ApiResponses

用于描述API操作的响应。

@Operation(summary = "获取用户列表")
@ApiResponses(value = {
    @ApiResponse(responseCode = "200", description = "成功", content = @Content(mediaType = "application/json", schema = @Schema(implementation = User.class))),
    @ApiResponse(responseCode = "400", description = "请求参数错误"),
    @ApiResponse(responseCode = "404", description = "找不到资源"),
    @ApiResponse(responseCode = "500", description = "服务器内部错误")
})
@GetMapping("/users")
public List<User> getUsers() {
    // ...
}

属性：

  • value：包含多个@ApiResponse注解。
@ApiResponse

用于描述单个响应。

属性：

  • responseCode：HTTP状态码。
  • description：描述信息。
  • content：响应内容类型和模式。
3. 参数级别注解
@Parameter

用于描述单个参数。

@Operation(summary = "获取用户详情")
@GetMapping("/{id}")
public User getUser(@Parameter(description = "用户ID", required = true) @PathVariable Long id) {
    // ...
}

属性：

  • name：参数名。
  • description：参数描述。
  • required：是否必须参数。
  • schema：参数模式。
@Parameters

用于描述多个参数。

@Operation(summary = "分页获取用户列表")
@Parameters({
    @Parameter(name = "page", description = "页码", required = true, schema = @Schema(type = "integer", example = "1")),
    @Parameter(name = "size", description = "每页数量", required = true, schema = @Schema(type = "integer", example = "10"))
})
@GetMapping("/users")
public List<User> getUsersByPage(@RequestParam int page, @RequestParam int size) {
    // ...
}

属性：

  • value：包含多个@Parameter注解。
4. 模型类注解
@Schema

用于描述模型类和字段的信息。

@Schema(description = "用户实体")
public class User {
    
    @Schema(description = "用户ID", example = "1")
    private Long id;

    @Schema(description = "用户名", example = "Alice")
    private String name;

    @Schema(description = "用户年龄", example = "30")
    private Integer age;

    // getters and setters
}

属性：

  • description：字段描述。
  • example：示例值。
  • required：是否必须字段。
  • type：字段类型。
@ArraySchema

用于描述数组类型的字段。

@Schema(description = "用户列表")
public class UserListResponse {

    @ArraySchema(schema = @Schema(implementation = User.class), description = "用户数组")
    private List<User> users;

    // getters and setters
}

属性：

  • schema：数组元素的模式。
  • description：数组描述。
5. 文件上传相关注解
@Operation(summary = "上传文件")
@PostMapping(value = "/upload", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
public String uploadFile(@Parameter(description = "文件", required = true) @RequestParam("file") MultipartFile file) {
    // ...
}

4. 访问地址

http://localhost:8080/doc.html
在这里插入图片描述

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

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

Mac 安装Mysql启动Mysql以及数据库的常规操作

Mac 安装Mysql启动Mysql以及数据库的常规操作

Mac 安装Mysql启动Mysql以及数据库的常规操作 一、mysql的安装 1、登录官方网站:dev.mysql.com/downloads/mysql/ 二、查看系统架构 uname -m 在MAC中&#xff1a; 如果输出结果是 x86_64&#xff0c;则表示你的系统是 x86-64 架构。 如果输出结果是 arm64&#xff0c;则表示…
阅读更多...
module ‘django.db.models‘ has no attribute ‘FieldDoesNotExist‘

module ‘django.db.models‘ has no attribute ‘FieldDoesNotExist‘

module ‘django.db.models’ has no attribute ‘FieldDoesNotExist’ xadmin报错 原因 django与xadmin版本不匹配。 django==3.2.7 xadmin-django==3.0.2解决方案 在xadmin/view/edit.py的388行改为 from django.core import exceptions if self.request_method ==
阅读更多...
马斯克X-AI发布了文生图模型Aurora,已经集成到聊天机器人Grok中。

马斯克X-AI发布了文生图模型Aurora,已经集成到聊天机器人Grok中。

千呼万唤&#xff0c;马斯克X-AI发布了文生图模型Aurora&#xff0c;并将其整合进了聊天机器人Grok中。Aurora不仅支持文本输入&#xff0c;还可从用户提供的图像中获取灵感&#xff0c;或直接编辑用户上传的图像。 Aurora 是一个自回归混合专家网络&#xff0c;经过训练可以从…
阅读更多...
如何在IDEA一个窗口中导入多个项目

如何在IDEA一个窗口中导入多个项目

一般在IDEA窗口中想导入一个新项目&#xff0c;会提示我们在当前窗口还是新窗口。如果选新窗口&#xff0c;就会新打开一个窗口&#xff0c;此时新窗口里面只有新导入的项目。 而为了浏览起来更方便&#xff0c;需要实现在IDEA一个窗口中导入多个项目。具体步骤如下&#xff1…
阅读更多...
Disruptor 有哪些典型的使用场景？

Disruptor 有哪些典型的使用场景？

大家好&#xff0c;我是君哥。 Disruptor 是一款高性能的内存有界队列&#xff0c;它通过内存预分配、无锁并发、解决伪共享问题、使用 RingBuffer 取代阻塞队列等措施来大幅提升队列性能。 但开发者们往往对它的使用场景不太了解&#xff0c;到底应该在哪些场景使用呢&#…
阅读更多...
网络药理学：3、零基础复现一篇生信文章：筛选疾病靶点、GeneCards、OMIM、TTD使用教程

网络药理学：3、零基础复现一篇生信文章：筛选疾病靶点、GeneCards、OMIM、TTD使用教程

一、前言 药物和疾病英文名 大黄英文名&#xff1a;Dahuang食管癌英文名&#xff1a;esophageal cancer 网站地址 TCMSP网站地址&#xff1a;https://old.tcmsp-e.com/tcmsp.phpGeneCards网站首页&#xff1a;https://www.genecards.org/OMIM网站首页&#xff1a;https://w…
阅读更多...
VK11\VK12保存增强

VK11\VK12保存增强

VK11\VK12保存增强 一、 VK11\VK12保存增强 事务码VK11、VK12创建和修改条件记录时&#xff0c;点击保存时修改其中的条件 二、增强步骤 通过查找&#xff0c;对应的BADI&#xff1a;SD_COND_SAVE_A 通过SE19创建BADI&#xff1a;ZSD_COND_SAVE_A修改函数CONDITION_SAVE_E…
阅读更多...
学习vue3的笔记

学习vue3的笔记

一、vue和react的对比 1、基础介绍 vue&#xff1a;https://cn.vuejs.org/ vue3是2020年创建的 react&#xff1a;https://react.dev/ react是一个2013年开源的JavaScript库&#xff0c;严格意义上来说不是一个框架 2、diff算法 两个框架采用的都是同级对比策略 两节点对…
阅读更多...
【kubernetes组件合集】深入解析Kubernetes组件之三：client-go

【kubernetes组件合集】深入解析Kubernetes组件之三：client-go

深入解析Kubernetes组件之三&#xff1a;client-go 目录 深入解析Kubernetes组件之三&#xff1a;client-go 引言 1. client-go简介 2. client-go的功能 2.1 资源操作 2.2 资源监听 2.3 认证和授权 2.4 错误处理和重试 2.5 扩展性和定制化 3. 使用client-go与Kubern…
阅读更多...
springboot533图书管理系统(论文+源码)_kaic

springboot533图书管理系统(论文+源码)_kaic

摘 要 传统信息的管理大部分依赖于管理人员的手工登记与管理&#xff0c;然而&#xff0c;随着近些年信息技术的迅猛发展&#xff0c;让许多比较老套的信息管理模式进行了更新迭代&#xff0c;图书信息因为其管理内容繁杂&#xff0c;管理数量繁多导致手工进行处理不能满足广…
阅读更多...
大数据数仓Hive和数据集市、数据治理

大数据数仓Hive和数据集市、数据治理

数仓&#xff08;Data Warehouse&#xff09; 为企业制定决策、提供数据支持的&#xff0c;可以帮助企业改进业务流程提高产品质量等。DW不是数据最终目的地&#xff0c;而是为数据最终目的地做好准备&#xff0c;这些准备包括对数据的备份&#xff0c;清洗&#xff0c;转义、…
阅读更多...
WebRTC线程的启动与运行

WebRTC线程的启动与运行

WebRTC线程运行的基本逻辑&#xff1a; while(true) {…Get(&msg, …);…Dispatch(&msg);… }Dispatch(Message *pmsg) {…pmsg->handler->OnMessage(pmsg);… }在执行函数内部&#xff0c;就是一个while死循环&#xff0c;只做两件事&#xff0c;从队列里Get取…
阅读更多...
一种pod容器动态挂卷方案

一种pod容器动态挂卷方案

一、背景 1.1 个人调试kvm 我们这边基于云平台的k8skubevirt&#xff0c;给安卓手机领域的开发工程师们提供了独占式虚拟机资源。这些资源主要用于工程师的个人级开发与调试&#xff0c;因此有如下特点&#xff1a; 使用时间与工作时间强相关&#xff0c;即工程师工作时间使…
阅读更多...
cesium 小知识：PostProcessStage 和 PostProcessStageLibrary详解对比

cesium 小知识：PostProcessStage 和 PostProcessStageLibrary详解对比

在Cesium中，PostProcessStage 和 PostProcessStageLibrary 是用于实现后期处理效果的关键API。它们允许开发者通过应用各种视觉效果来增强3D场景的渲染质量或实现特定的视觉需求。下面将详细介绍这两个API，并对比它们的功能和使用方法。 PostProcessStage 1. 概念 后期处理…
阅读更多...
如何使用AI工具cursor(内置ChatGPT 4o+claude-3.5）

如何使用AI工具cursor(内置ChatGPT 4o+claude-3.5）

⚠️温馨提示&#xff1a; 禁止商业用途&#xff0c;请支持正版&#xff0c;充值使用&#xff0c;尊重知识产权&#xff01; 免责声明&#xff1a; 1、本教程仅用于学习和研究使用&#xff0c;不得用于商业或非法行为。 2、请遵守Cursor的服务条款以及相关法律法规。 3、本…
阅读更多...
Flink operator实现自动扩缩容

Flink operator实现自动扩缩容

官网文档位置&#xff1a; 1.Autoscaler | Apache Flink Kubernetes Operator 2.Configuration | Apache Flink Kubernetes Operator 1.部署K8S集群 可参照我之前的文章k8s集群搭建 2.Helm安装Flink-Operator helm repo add flink-operator-repo https://downloads.apach…
阅读更多...
深入Android架构(从线程到AIDL)_03 IPC的IBinder接口

深入Android架构(从线程到AIDL)_03 IPC的IBinder接口

目录 4、 IPC的IBinder接口 -- 定义与实现 IBinder接口的定義 IBinder接口的實現類 Java层的Binder基类定义​编辑 Binder基类的主要函数 Java层的BinderProxy基类定义 4、 IPC的IBinder接口 -- 定义与实现 IBinder接口的定義 大家都知道&#xff0c;当两个类都在同一个…
阅读更多...
vscode代码AI插件Continue 安装与使用

vscode代码AI插件Continue 安装与使用

“Continue” 是一款强大的插件&#xff0c;它主要用于在开发过程中提供智能的代码延续功能。例如&#xff0c;当你在编写代码并且需要进行下一步操作或者完成一个代码块时&#xff0c;它能够根据代码的上下文、语法规则以及相关的库和框架知识&#xff0c;为你提供可能的代码续…
阅读更多...
我的Java-Web进阶--SpringMVC

我的Java-Web进阶--SpringMVC

1.三层架构与MVC模式 三层架构 MVC模式 2.SpringMVC执行流程 3.SpringMVC的基本使用方法 1. 配置 1.1 Maven依赖 首先&#xff0c;在pom.xml文件中添加Spring MVC的依赖&#xff1a; <dependencies><!-- Spring MVC --><dependency><groupId>org.…
阅读更多...
flux中的缓存

flux中的缓存

1. cache&#xff0c;onBackpressureBuffer。都是缓存。cache可以将hot流的数据缓存起来。onBackpressureBuffer也是缓存&#xff0c;但是当下游消费者的处理速度比上游生产者慢时&#xff0c;上游生产的数据会被暂时存储在缓冲区中&#xff0c;防止丢失。 2. Flux.range 默认…
阅读更多...
最新文章

Copyright @ 2022~2023