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

相关推荐
lly202406几秒前
C# 正则表达式
开发语言
Chef_Chen3 分钟前
从0开始学习R语言--Day58--竞争风险模型
android·开发语言·kotlin
minji...18 分钟前
数据结构 堆(4)---TOP-K问题
java·数据结构·算法
咖啡の猫26 分钟前
bash的特性-常见的快捷键
开发语言·chrome·bash
命苦的孩子28 分钟前
Java 中的排序算法详解
java·开发语言·排序算法
咖啡の猫28 分钟前
bash的特性-常用的通配符
开发语言·chrome·bash
java叶新东老师1 小时前
spring gateway 配置http和websocket路由转发规则
spring·http·gateway
Seven971 小时前
Spring AI 框架中如何集成 MCP?
java
开往19821 小时前
spring boot整合mybatis
java·spring boot·mybatis
淮北4941 小时前
STL学习(四、队列和堆栈)
开发语言·c++·学习