简介
欢迎使用本项目的 API 文档!以下是关于如何高效利用 API 文档的说明:
访问路径
您可以通过/api-docs/intro
查看文档的完整介绍,或通过/api-docs/endpoints
查看具体接口列表。功能亮点
- 实时更新的接口说明
- 支持多种请求方式(GET/POST/PUT/DELETE)
- 参数与响应格式清晰展示
- 嵌入式 Swagger UI 工具 🛠️
使用建议
- 配合浏览器开发者工具调试请求
- 通过
/api-docs/parameters
查看参数详解 - 使用
/api-docs/authorization
了解认证方式
操作演示
以下为典型使用场景示例:
查看接口详情
👉 点击 此处 可直接跳转到接口列表页面,支持按模块分类浏览。测试 API 请求
Swagger_UI_示意图
图示:Swagger UI 界面展示获取文档更新日志
🔎 通过/api-docs/changelog
查看最近的版本更新记录。
常见问题
❓ 如何下载文档?
- 点击 下载 PDF 版本 可获取离线文档
❓ 如何贡献文档?
- 请参考 文档贡献指南 提交更新或修正