Hyreal Sports API 文档

全面、详细的API接口文档,帮助开发者快速集成Hyreal Sports平台功能

查看文档 详细文档

API文档概览

认证模块

包括用户注册、登录、Token管理等功能

查看详情
用户管理

用户信息获取、更新、好友系统等

查看详情
设备管理

设备绑定、信息查询、固件更新等

查看详情
锻炼计划

计划创建、更新、查询等功能

查看详情
AI功能

基于Ollama的AI交互和拳击动作识别

查看详情
其他功能

启动页文本、消息服务等

查看详情

模块详情

功能描述

处理用户身份验证,包括注册、登录、Token刷新等。

相关文件
  • routes/auth.py - 路由实现
  • utils/jwt_utils.py - JWT工具
  • utils/token_utils.py - Token工具
主要类和函数
  • generate_sms_code() - 生成短信验证码
  • send_sms_code() - 发送短信验证码
  • sms_login() - 短信登录
  • refresh_token() - 刷新Token

功能描述

管理用户个人信息、好友关系等。

相关文件
  • routes/user.py - 路由实现
  • utils/db_utils.py - 数据库工具
主要类和函数
  • get_user_info() - 获取用户信息
  • update_user_info() - 更新用户信息
  • get_friends_list() - 获取好友列表
  • add_friend() - 添加好友
  • delete_friend() - 删除好友

功能描述

处理用户设备的绑定、查询和管理。

相关文件
  • routes/device.py - 路由实现
主要类和函数
  • bind_device() - 绑定设备
  • get_device_info() - 获取设备信息
  • update_device_info() - 更新设备信息
  • get_firmware_info() - 获取固件信息

功能描述

包括基于Ollama的大语言模型交互和自研的拳击动作识别AI模型。

相关文件
  • routes/ollama_api.py - Ollama API路由实现
  • routes/AIboxing.py - 拳击动作识别路由实现
  • utils/model_loader.py - AI模型加载工具
  • models/ - 拳击动作识别模型文件目录
主要类和函数
  • OllamaClient - Ollama客户端类
  • BoxingModelManager - 拳击动作识别模型管理器
  • analyze_boxing_action() - 分析拳击动作函数
  • chat_with_ollama() - 与Ollama对话函数