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

相关推荐
FrankYoou1 小时前
Jenkins 与 GitLab CI/CD 的核心对比
java·docker
麦兜*1 小时前
Spring Boot启动优化7板斧(延迟初始化、组件扫描精准打击、JVM参数调优):砍掉70%启动时间的魔鬼实践
java·jvm·spring boot·后端·spring·spring cloud·系统架构
Coding小公仔1 小时前
C++ bitset 模板类
开发语言·c++
KK溜了溜了2 小时前
JAVA-springboot 整合Redis
java·spring boot·redis
大只鹅2 小时前
解决 Spring Boot 对 Elasticsearch 字段没有小驼峰映射的问题
spring boot·后端·elasticsearch
小赖同学啊2 小时前
物联网数据安全区块链服务
开发语言·python·区块链
天河归来2 小时前
使用idea创建springboot单体项目
java·spring boot·intellij-idea
shimly1234562 小时前
bash 脚本比较 100 个程序运行时间,精确到毫秒,脚本
开发语言·chrome·bash
weixin_478689762 小时前
十大排序算法汇总
java·算法·排序算法