RESTful API 设计规范：从入门到精通

设计一套好的 API 能极大提升开发效率和用户体验。本文总结 RESTful API 的核心设计原则。

资源命名规范

✅ 正确：

GET /users
GET /users/123
GET /users/123/posts

❌ 错误：

GET /getUsers
GET /user?id=123
POST /createUser

HTTP 方法语义

状态码使用

• 200 OK：成功
• 201 Created：创建成功
• 400 Bad Request：参数错误
• 401 Unauthorized：未认证
• 403 Forbidden：无权限
• 404 Not Found：资源不存在
• 500 Internal Server Error：服务器错误

响应格式

{
  "code": 0,
  "message": "success",
  "data": {
    "id": 123,
    "name": "示例"
  }
}

版本控制

在 URL 中包含版本号：/api/v1/users

遵循这些规范，让你的 API 更专业、更易用！