超腾开源平台API文档

超腾开源平台是一套完整的解决方案，包含管理后台服务端、管理后台前端和多个移动应用。本文档详细介绍了平台所有 API 接口，供开发人员参考和使用。

技术栈

• 后端框架: FastAPI (Python)
• 前端框架: Vue3 + TypeScript + Ant Design Vue
• 小程序框架: uni-app
• API 文档格式: RESTful API

API 基础信息

基础 URL

开发环境: http://localhost:8000/api
生产环境: https://api.example.com/api

认证方式

平台使用 JWT (JSON Web Token) 进行身份认证。

获取 Token:

POST /api/system/login/access-token
Content-Type: application/json

{
  "username": "your_username",
  "password": "your_password",
  "captcha_key": "captcha_key",
  "captcha_value": "captcha_value"
}

使用 Token:

Authorization: Bearer {access_token}

通用响应格式

所有 API 接口都遵循统一的响应格式：

{
  "success": true,
  "code": 200,
  "msg": "操作成功",
  "data": {}
}

字段说明:

• success: 请求是否成功
• code: 状态码（200 表示成功，其他表示失败）
• msg: 消息描述
• data: 返回的数据

分页响应格式

{
  "success": true,
  "code": 200,
  "msg": "操作成功",
  "data": {
    "total": 100,
    "size": 10,
    "pages": 10,
    "current": 1,
    "records": [],
    "orders": []
  }
}

字段说明:

• total: 总记录数
• size: 每页记录数
• pages: 总页数
• current: 当前页码
• records: 当前页数据列表
• orders: 排序信息

API 模块索引

1. 仪表盘模块

提供系统统计数据的仪表盘接口。

查看详细文档 →

2. 系统模块

提供用户、角色、菜单、权限、组织机构、应用、系统参数、业务字典、日志管理等系统核心功能。

查看详细文档 →

3. 工作模块

提供消息通知和工作计划管理功能。

查看详细文档 →

4. 内容模块

提供博客、微博、Wiki、产品文档、留言板、意见反馈、友情链接等内容管理功能。

查看详细文档 →

5. 商业模块

提供商品、订单、评价、收藏、购物车、软件、支付等电子商务功能。

查看详细文档 →

6. AI 模块

提供 AI 提示词、大模型、大模型提供商、MCP 工具、智能体、IDE 账号等 AI 相关功能。

查看详细文档 →

7. 工具模块

提供网站检测、SEO 优化、IndexNow、XWiki 同步、百度推送、网站链接管理等工具功能。

查看详细文档 →

8. 统计模块

提供站点统计和爬虫日志分析功能。

查看详细文档 →

9. 资源模块

提供远程主机管理和监控功能。

查看详细文档 →

10. 网站模块

提供公开访问的网站端接口，包括用户注册、登录、博客、商品等。

查看详细文档 →

数据模型参考

查看所有数据模型的详细定义和字段说明。

查看数据模型 →

快速开始

1. 获取访问令牌

curl -X POST "http://localhost:8000/api/system/login/access-token" \
  -H "Content-Type: application/json" \
  -d '{
    "username": "admin",
    "password": "password",
    "captcha_key": "key",
    "captcha_value": "value"
  }'

2. 使用令牌访问 API

curl -X GET "http://localhost:8000/api/system/users/me" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

3. 获取用户列表

curl -X GET "http://localhost:8000/api/system/users/list?page=1&page_size=10" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

错误码说明

开发指南

环境要求

• Python 3.12+
• Node.js 20+
• MySQL 8.0+

本地开发

1. 启动后端服务

cd server
pip install -r requirements.txt
python main.py

2. 启动前端服务

cd front
npm install
npm run dev

3. 启动网站服务

cd website
npm install
npm run dev

更新日志

v1.0.0 (2025-01-03)

• 初始版本发布
• 完成所有核心功能开发
• 提供 350+ API 接口

联系我们

• 官方网站: https://www.hylab.com
• 文档地址: /product?parent_id=7413021656836345856
• 邮箱: hylab@qq.com