Documentation
README
后端 API 开发方法论
API 契约管理
契约来源
实现 API 前，必须阅读 architecture.md §5（API 设计），获取：
- API 规范（RESTful/GraphQL）
- 接口列表（方法、路径、描述、认证要求）
- 请求/响应格式约定
- 错误码规范
契约遵守原则
- 严格实现：API 端点的方法、路径、参数必须与 architecture.md §5 一致
- 响应格式：遵循统一的成功/错误响应结构
- 偏差记录：如需偏离契约，必须在输出报告中标注原因
- 类型导出：将请求/响应类型导出到共享文件，供前端引用
RESTful API 设计
资源命名规范
| 操作 | HTTP 方法 | 路径 | 说明 |
|---|---|---|---|
| 列表 | GET | /api/users |
获取用户列表 |
| 详情 | GET | /api/users/:id |
获取单个用户 |
| 创建 | POST | /api/users |
创建新用户 |
| 更新 | PUT/PATCH | /api/users/:id |
更新用户 |
| 删除 | DELETE | /api/users/:id |
删除用户 |
统一响应格式
成功响应：
{
"success": true,
"data": { ... },
"message": "Operation successful"
}
This is the opening of the README. Read the full README on GitHub.