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

相关推荐
Flittly10 分钟前
【AgentScope Java新手村系列】(16)从RAG到多路检索
java·spring boot·spring
小兔崽子去哪了16 分钟前
Java 生成二维码解决方案
java·后端
人活一口气5 小时前
从JVM调优到MCP协议:Java全栈技术体系深度总结与企业级架构实践
java·spring boot
NE_STOP7 小时前
Vibe Coding -- 完整项目案例实操
java
荣码7 小时前
GraphRAG:普通RAG只能回答"点"的问题,我踩了4个坑才搞懂
java·python
SimonKing7 小时前
Google第三方授权登录
java·后端·程序员
明月光8187 小时前
从一行 @Builder 说起:重新拾起 Java 的 Lombok、注解与 Builder 模式
java
考虑考虑16 小时前
Mybatis实现批量插入
java·后端·mybatis
咖啡八杯17 小时前
GoF设计模式——中介者模式
java·后端·spring·设计模式
青石路21 小时前
记一次多JDK版本问题的排查,一坑套一坑,差点没爬上来
java