Skip to content

API 概览

服务启动后可访问 Swagger:

http://localhost:2567/api-docs

API 默认前缀为 /api

认证与登录

  • POST /api/auth/login:账号登录并获取 JWT
  • POST /api/auth/refresh:刷新 Token

HTTP Bearer 与 Colyseus 进房传参的对应关系、Redis 校验规则见:JWT 与房间鉴权

小游戏接口

包括 微信小游戏登录抖音小游戏登录接口,以及对应的 access_token 获取接口:

  • GET /api/minigame/douyin/access_token
  • GET /api/minigame/douyin/login
  • GET /api/minigame/weixin/access_token
  • GET /api/minigame/weixin/login

登录类接口在换取平台 openid(及抖音侧匿名 id 等)后,会 自动查找或创建 本地用户,响应中包含 token(JWT)user(本地用户资料,不含密码);JWT 中的 userId 为数据库用户主键,与平台 openid 不同。详见教程。

教程:

调试建议

  • 开发阶段优先通过 Swagger 调试参数。
  • 接入 Colyseus 房间前,先获取并验证 JWT。