Files
MemeMind-Server/docs/api/README.md
richarjiang fe2c13258e refactor: 拆分核心玩法模块并优化代码质量
将 WechatGame 单体模块拆分为独立的 User、Level、GameConfig 模块,
新增体力值系统、关卡闯关流程,并修复多项代码质量问题:
- 体力不足错误码从 401 修正为 400
- enterLevel 改用 findById 替代全表扫描
- consumeStamina 增加原子更新防止并发竞态
- 并行化独立数据库查询 (Promise.all)
- 移除 WechatGameService/Controller 死代码
2026-04-10 09:07:50 +08:00

53 lines
1.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# MemeMind API 文档索引
> 本目录包含 MemeMind 微信小游戏所有 API 接口文档。
## 文档列表
| 模块 | 文档文件 | 说明 | 状态 |
|------|----------|------|------|
| 核心玩法 | [game-api.md](./game-api.md) | 认证、体力值、关卡闯关、游戏配置 | ✅ 已完成 |
| 分享挑战 | [share-challenge-api.md](./share-challenge-api.md) | 创建分享、加入挑战、进度上报 | ✅ 已完成 |
| 排行榜 | [leaderboard-api.md](./leaderboard-api.md) | 排名、分数上报 | 预留 |
## 文档维护规则
每当接口发生变更时,必须同步更新对应文档:
- **新增接口** → 在对应模块文档中新增章节
- **修改接口** → 更新现有章节内容
- **删除接口** → 标记废弃或移除并通知客户端
详见:[API 文档维护技能](../../.claude/skills/api-doc-maintainer/SKILL.md)(项目级 Skill
## 通用规范
### 认证方式
所有需要认证的接口通过 JWT Bearer Token 鉴权:
```
Authorization: Bearer <token>
```
### 响应格式
所有接口返回统一格式:
```json
{
"success": true,
"data": { "..." : "..." },
"message": null,
"timestamp": "2026-04-10T12:00:00.000Z"
}
```
### 基础路径
```
生产环境https://api.mememind.com/api
本地开发http://localhost:3000/api
```
## 客户端接入
客户端基于 Cocos Creator 开发,接入示例详见各模块文档。