Files
MemeMind-Server/docs/api/README.md
2026-04-08 16:02:19 +08:00

1.5 KiB
Raw Blame History

MemeMind API 文档索引

本目录包含 MemeMind 微信小游戏所有 API 接口文档。

文档列表

模块 文档文件 说明 状态
用户认证 auth-api.md 微信登录、JWT Token 待编写
分享挑战 share-challenge-api.md 创建分享、加入挑战、进度上报 已完成
游戏关卡 game-api.md 关卡数据、答案验证 待编写
用户资产 user-assets-api.md 积分获取与消耗 待编写
排行榜 leaderboard-api.md 排名、分数上报 预留

文档维护规则

每当接口发生变更时,必须同步更新对应文档:

  • 新增接口 → 在对应模块文档中新增章节
  • 修改接口 → 更新现有章节内容
  • 删除接口 → 标记废弃或移除并通知客户端

详见:API 文档维护技能(项目级 Skill

通用规范

认证方式

所有需要认证的接口通过 JWT Bearer Token 鉴权:

Authorization: Bearer <token>

响应格式

所有接口返回统一格式:

{
  "success": true,
  "data": { ... },
  "message": null,
  "timestamp": "2026-04-08T12:00:00.000Z"
}

基础路径

生产环境https://api.mememind.com/api
本地开发http://localhost:3000/api

客户端接入

客户端基于 Cocos Creator 开发,接入示例详见各模块文档。