RESTful API 设计规范指南

核心原则

RESTful API 遵循资源导向的设计理念，使用 HTTP 方法表达操作。

HTTP 方法语义

URL 设计规范

# 好的设计
GET /users/123
POST /users
PUT /users/123
DELETE /users/123

# 避免动词
❌ /getUser/123
✅ /users/123

状态码使用

• 200: 成功
• 201: 创建成功
• 400: 请求错误
• 401: 未授权
• 403: 禁止访问
• 404: 资源不存在
• 500: 服务器错误

响应格式

{
  "code": 0,
  "message": "success",
  "data": {...}
}

版本控制

/api/v1/users
/api/v2/users

规范的 API 设计让前后端协作更顺畅！