Swagger API 文档指南 📚

欢迎使用我们的 API 文档系统！通过 /api-docs/swagger 访问交互式界面，可实时查看接口说明、参数详情及示例请求。
📌 提示：若需了解更多，请访问 /docs/overview 查看文档总览。

📝 快速上手

1. 访问路径
   直接输入 /api-docs/swagger 即可打开 Swagger 界面
   👉 示例：http://yourdomain.com/api-docs/swagger

2. 功能亮点

   • 实时调试 API 接口 ✅
   • 自动生成请求参数说明 📊
   • 支持多种请求方法（GET/POST/PUT/DELETE） 🔄
   • 可视化响应格式展示 🧾

3. 使用技巧

   • 点击接口名称可展开详细说明 🔍
   • 修改请求参数后点击 "Try it out" 按钮即可发送请求 🚀
   • 支持自定义请求头和查询参数 🧾

📎 文档结构

Swagger 界面默认展示以下内容：

• 接口列表 📋
• 请求参数说明 📜
• 响应数据格式 📊
• 示例请求与响应 📌

图片展示：

🛡 安全提示

• 请勿在生产环境中暴露 Swagger 界面 🚫
• 若需隐藏接口文档，可通过配置 /docs/hide 路径实现 🔒
• 所有请求均需遵循 API 使用规范

图片展示：