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

相关推荐
步行cgn44 分钟前
Spring c 命名空间注入详解
java·后端·spring
明月_清风1 小时前
Maven 到底是什么?一篇文章搞懂 Java 项目构建与依赖管理
java·后端·maven
aramae1 小时前
MySQL复合查询(8)
java·c语言·开发语言·后端·算法
Rain的Java大神之路2 小时前
如何快速上传10G文件
java·spring boot·redis·后端·mysql·spring cloud·面试
Wang's Blog2 小时前
Java 接入Redis: 通用命令与键管理
java·服务器·redis
Wang's Blog3 小时前
Java 接入Redis: 列表集合与有序集合操作命令
java·服务器·redis
Ivanqhz3 小时前
SVD++算法
java·服务器·网络·深度学习·神经网络
qq_2518364574 小时前
springboot vue3 开发实现 拼豆管理系统
java·开发语言·ai编程
caoerzhong4 小时前
JeeWMS 开源仓库管理系统全景解读:一套 Java WMS 如何把 WMS/OMS/BMS/TMS 装进同一个系统
java·开源
曹牧4 小时前
Java集合框架:List、ArrayList、Map 和 HashMap
java