A8中级
API 设计评审
45 分钟每个新API
格式:评审一个 API 设计,找出问题。
给你一个 API 设计(故意有问题):
POST /api/getUsers ← 问题在哪?
GET /api/user/delete/123 ← 问题在哪?
POST /api/data ← 问题在哪?
GET /api/userOrderListAll ← 问题在哪?
对比好的设计:
GET /api/users ← 获取用户列表
GET /api/users/123 ← 获取单个用户
POST /api/users ← 创建用户
PUT /api/users/123 ← 更新用户
DELETE /api/users/123 ← 删除用户
GET /api/users/123/orders ← 获取用户的订单
审查清单:
- HTTP 方法和操作匹配吗?(GET 只读,POST 创建,PUT 更新,DELETE 删除)
- URL 命名用名词复数吗?(/users 而非 /user 或 /getUser)
- 资源层级清晰吗?(/users/123/orders 表示"用户123的订单")
- 错误响应格式一致吗?
- 有版本管理吗?(/api/v1/users)
评判标准(自测)
0/5你会学到
API 是契约——好的 API 设计能用十年不变。