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类中实现对日期的转换

相关推荐
无限进步_2 分钟前
【C语言】计算两个整数二进制表示中不同位的个数
c语言·开发语言
道可到13 分钟前
淘宝面试原题 Java 面试通关笔记 02|从编译到运行——Java 背后的计算模型(面试可复述版)
java·后端·面试
DKPT19 分钟前
JVM如何管理直接内存?
java·笔记·学习
SimonKing20 分钟前
GitHub 标星 370k!免费编程资源大合集,从此自学不花一分钱
java·后端·程序员
come1123424 分钟前
深入Spring Boot生态中最核心部分 数据库交互spring-boot-starter-data-jpa和Hibernate (指南五)
数据库·spring boot·hibernate
kfepiza31 分钟前
Java的任务调度框架之Quartz 笔记250930
java·java ee
自由的疯32 分钟前
Java(32位)基于JNative的DLL函数调用方法
java·后端·架构
咖啡Beans36 分钟前
SpringBoot+Ehcache使用示例
java·spring boot
自由的疯39 分钟前
Java 使用Jackson进行深拷贝:优化与最佳实践
java·后端·架构
毕设源码-郭学长44 分钟前
【开题答辩全过程】以 springboot+美食电子商城的设计与实现为例,包含答辩的问题和答案
java·eclipse·美食