郴州RESTful API设计规范：一份适合团队协作的API开发标准文档
URL设计规范
| 场景 | 正确写法 | 错误写法 |
|---|---|---|
| 获取用户列表 | GET /api/users | GET /api/getAllUsers |
| 获取单个用户 | GET /api/users/:id | GET /api/user/info/:id |
| 创建用户 | POST /api/users | POST /api/createUser |
| 更新用户 | PUT /api/users/:id | POST /api/updateUser/:id |
| 删除用户 | DELETE /api/users/:id | GET /api/deleteUser/:id |
统一响应格式
{
"code": 0,
"message": "success",
"data": { ... },
"timestamp": 1704067200000
}其他规范要点
- 使用HTTP动词表达语义（GET/POST/PUT/DELETE/PATCH）
- 用名词复数表示资源（users/orders/products）
- 版本号放在URL中（/api/v1/）
- 使用查询参数做过滤、排序和分页
- 正确使用HTTP状态码（200/201/400/401/403/404/500）