RESTful API 设计规范指南

好的 API 设计让前后端协作更顺畅：

资源命名

• 使用名词复数：/users, /articles
• 小写字母，连字符分隔：/user-profiles
• 避免动词：用 HTTP 方法表达操作

HTTP 方法

• GET: 获取资源
• POST: 创建资源
• PUT: 全量更新
• PATCH: 部分更新
• DELETE: 删除资源

状态码

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

版本控制

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

响应格式

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

最佳实践：文档先行（OpenAPI/Swagger），保持向后兼容，合理使用缓存。