API 文档模块
简介
continew-starter-api-doc 是 ContiNew Starter 针对 API 文档模块的默认处理，底层基于 Knife4j。
xml
<dependency>
<groupId>top.continew.starter</groupId>
<artifactId>continew-starter-api-doc</artifactId>
</dependency>主要特性
- 版本锁定：涉及依赖已进行版本锁定，使用时无需配置版本
- 默认配置：已配置 API 文档通用配置，且已针对静态资源路径进行处理映射
/favicon.ico、/doc.html、/webjars/** - 鉴权配置：在配置文件中支持指定 API 全局鉴权配置
配置示例
配置详情请查看：top.charles7c.continew.starter.apidoc.autoconfigure.SpringDocExtensionProperties。
yaml
--- ### 接口文档配置
springdoc:
## 组件配置
components:
# 鉴权配置
security-schemes:
Authorization:
type: HTTP
in: HEADER
name: 你的 Token 名称
scheme: 你的 Token 前缀
## 其他配置略
# ...温馨提示
下方 API 文档配置已经在本模块中进行了默认配置，使用者无需再进行配置，如需要更改，可进行覆盖配置。
yaml
--- ### 接口文档配置
springdoc:
swagger-ui:
path: /swagger-ui.html
tags-sorter: alpha
operations-sorter: alpha
show-extensions: true
api-docs:
enabled: ${springdoc.swagger-ui.enabled}
path: /v3/api-docs
## 接口文档增强配置
knife4j:
setting:
language: zh_cn
swagger-model-name: 实体类列表核心依赖
| 依赖 | 描述 |
|---|---|
| continew-starter-core | |
| knife4j-openapi3-jakarta-spring-boot-starter | Knife4j（前身是 swagger-bootstrap-ui，集 Swagger2 和 OpenAPI3 为一体的增强解决方案） |