1. 引入依赖
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
<version>4.4.0</version>
</dependency>
2. 配置文件
简短必要版
# 配置springdoc-openapi,用于文档化和访问API
springdoc:
# 配置Swagger UI的访问路径和排序方式
swagger-ui:
path: /swagger-ui.html # Swagger UI的访问路径
tags-sorter: alpha # 按字母顺序排序标签
operations-sorter: alpha # 按字母顺序排序操作
# 配置API文档的访问路径
api-docs:
path: /v3/api-docs # API文档的访问路径
# 配置API分组,用于组织和管理API
group-configs:
- group: 'default' # API分组名称
paths-to-match: '/**' # 匹配所有路径
packages-to-scan: com.ykx.easyexceldemo02.controller # 扫描的包,用于自动发现API
# knife4j的增强配置,不需要增强可以不配(详细版见下小节)
knife4j:
enable: true
setting:
language: zh_cn
详细全部版
# 配置Knife4j,以启用Swagger文档的增强功能和定制化展示
knife4j:
# 启用Knife4j扩展
enable: true
# 配置展示的文档分组
documents:
-
# 文档分组标题
group: 2.X版本
# 文档分组描述
name: 接口签名
# 指定接口文档的位置
locations: classpath:sign/*
# 配置Knife4j的展示细节和功能开关
setting:
# 设置界面语言
language: zh-CN
# 启用Swagger模型展示
enable-swagger-models: true
# 启用文档管理功能
enable-document-manage: true
# 设置Swagger模型的显示名称
swagger-model-name: 实体类列表
# 是否显示版本信息
enable-version: false
# 是否启用参数缓存刷新
enable-reload-cache-parameter: false
# 启用后端脚本支持
enable-after-script: true
# 过滤特定方法类型的multipart/form-data接口
enable-filter-multipart-api-method-type: POST
# 是否过滤所有multipart/form-data类型的接口
enable-filter-multipart-apis: false
# 启用请求缓存
enable-request-cache: true
# 是否显示自定义主机名
enable-host: false
# 设置自定义的主机名
enable-host-text: 192.168.0.193:8000
# 启用自定义首页
enable-home-custom: true
# 设置自定义首页的路径
home-custom-path: classpath:markdown/home.md
# 是否启用搜索功能
enable-search: false
# 是否显示页脚
enable-footer: false
# 启用自定义页脚内容
enable-footer-custom: true
# 设置自定义页脚的内容
footer-custom-content: Apache License 2.0 | Copyright 2019-[浙江八一菜刀股份有限公司](https://gitee.com/xiaoym/knife4j)
# 是否启用动态参数
enable-dynamic-parameter: false
# 启用调试模式
enable-debug: true