API 参考

概述

数据库管理 API 提供完整的 MySQL 数据库操作接口，支持数据库管理、表操作、数据查询、备份恢复等功能。

快速开始

基础请求格式

GET /health
Authorization: Bearer your_api_key
Content-Type: application/json

响应格式

{
  "success": true,
  "data": {...},
  "message": "操作成功"
}

API 分类

🔍 健康检查

• GET /health - 服务健康状态检查

🗄️ 数据库管理

• POST /create - 创建数据库
• GET /databases - 列出所有数据库
• DELETE /database/{db_name} - 删除数据库
• GET /database/{db_name}/info - 数据库详细信息

📊 表操作

• GET /database/{db_name}/tables - 获取数据库表列表
• POST /database/{db_name}/table - 创建数据表
• GET /database/{db_name}/table/{table_name}/structure - 获取表结构

💾 数据操作

• POST /database/{db_name}/table/{table_name}/data - 插入数据
• GET /database/{db_name}/table/{table_name}/data - 查询数据
• POST /database/{db_name}/query - 执行SQL查询
• GET /database/{db_name}/tables-info - 获取所有表信息

⚡ 批量操作

• POST /database/{db_name}/batch/update - 批量更新数据
• POST /database/{db_name}/batch/delete - 批量删除数据
• POST /database/{db_name}/export - 导出数据(CSV/JSON)
• POST /database/{db_name}/import - 导入数据
• GET /download/export/{filename} - 下载导出文件

💽 备份恢复

• POST /database/{db_name}/backup - 创建数据库备份
• GET /database/{db_name}/backups - 获取备份列表
• GET /backup/{filename} - 下载备份文件
• DELETE /backup/{filename} - 删除备份文件
• POST /database/{db_name}/backup/auto - 配置自动备份
• GET /database/{db_name}/backup/{backup_id}/status - 备份任务状态
• GET /database/{db_name}/backup/tasks - 备份任务列表

📈 监控统计

• GET /stats/database - 数据库统计概览
• GET /stats/database/{db_name} - 单个数据库统计
• GET /stats/performance - 数据库性能统计
• GET /stats/query-analysis - 查询分析统计
• GET /stats/api-usage - API使用统计
• GET /stats/system - 系统统计信息
• GET /stats/summary - 统计摘要

👥 用户管理

认证相关

• POST /auth/login - 用户登录
• POST /auth/register - 用户注册
• POST /auth/logout - 用户登出
• GET /auth/profile - 获取用户信息
• POST /auth/change-password - 修改密码

管理员功能

• POST /admin/users - 创建用户
• GET /admin/users - 列出所有用户
• PUT /admin/users/{user_id} - 更新用户信息
• DELETE /admin/users/{user_id} - 删除用户
• GET /admin/api-keys - 列出API密钥
• POST /admin/users/{user_id}/reset-password - 重置用户密码
• POST /admin/database-permissions - 授予数据库权限

用户功能

• GET /user/databases - 获取用户数据库列表

通用规范

认证方式

Authorization: Bearer your_api_key

错误响应

{
  "error": "错误描述",
  "code": "错误代码(可选)"
}

分页响应

{
  "data": [...],
  "pagination": {
    "page": 1,
    "page_size": 20,
    "total_count": 100,
    "total_pages": 5
  }
}

状态码说明

状态码	说明
200	成功
201	创建成功
400	请求参数错误
401	认证失败
403	权限不足
404	资源不存在
409	资源冲突
429	请求过于频繁
500	服务器内部错误

下一步

• 📖 查看 使用指南
• 🔧 学习 使用示例
• 📚 参考 完整文档