SpringMVC(八)Knife4j 接口文档

目录

[一 基础使用](#一 基础使用)

[1 配置pom.xml相关依赖](#1 配置pom.xml相关依赖)

[2 项目配置](#2 项目配置)

[3 输入指定路径(http://localhost:8080/doc.html)](#3 输入指定路径(http://localhost:8080/doc.html))

[二 一些使用方法](#二 一些使用方法)

[1 Tag](#1 Tag)

[2 Operation](#2 Operation)

[3 Schema](#3 Schema)

[4 Parameter](#4 Parameter)

[5 可以根据需求来设置](#5 可以根据需求来设置)

补充:日期的格式化


Knife4j 是基于 Swagger(OpenAPI)的增强工具,专注于 生成、管理和展示 API 文档,主要作用包括:

  • 自动生成接口文档:通过注解自动生成标准化、可视化的 API 文档。

  • 提升协作效率:前后端开发、测试、产品等角色可通过文档快速理解接口定义。

  • 支持接口调试:直接在文档页面发起请求,验证接口功能。

  • 离线文档导出:生成 Markdown、HTML 等格式的离线文档,便于归档或分享。

网站链接

快速开始 | Knife4j

一 基础使用

1 配置pom.xml相关依赖

2 项目配置

3 输入指定路径(http://localhost:8080/doc.html)

可能出现的问题

尚硅谷新SSM教程中关于Knife4j 接口文档无法显示接口的问题_knife4j没有接口列表-CSDN博客

二 一些使用方法

1 Tag

实现:

实现结果:

2 Operation

实现:

实现结果:

3 Schema

实现:

实现结果:

原来的

实现之后的

4 Parameter

实现:

实现之前

实现后

5 可以根据需求来设置

实现

实现前

实现后

补充:日期的格式化

日期的查询:

在Vo类中实现对日期的转换

相关推荐
亦暖筑序18 分钟前
《Spring AI 实战系列 入门篇》第 3 篇
java
golang学习记21 分钟前
Go 实时批处理:让数据库少挨点打 [特殊字符]
开发语言·数据库·golang
Memory_荒年22 分钟前
Netty:从“网络搬砖”到“流水线大师”的奇幻之旅
java·后端
ChaseDreamRunner36 分钟前
如何用 NSSM 把 Jar 做成 Windows 服务
java·windows·jar
神の愛37 分钟前
java的Aop
java·开发语言
左左右右左右摇晃1 小时前
ConcurrentHashMap ——put + get
java·开发语言·笔记
gaozhiyong08131 小时前
深度技术拆解:豆包2 Pro vs Gemini 3—国产工程派与海外原生派的巅峰对决
前端·spring boot·mysql
今夕资源网1 小时前
零基础 Python 环境搭建工具 一键安装 Python 环境自动配置 升级 pip、setuptools、wheel
开发语言·python·pip·环境变量·python环境变量·python自动安装
啥咕啦呛1 小时前
java打卡学习4:HashMap底层结构、扩容机制
java·学习·哈希算法
qq_297574671 小时前
K8s系列第十四篇:K8s 故障排查实战:常见故障定位与解决方法
java·docker·kubernetes