RESTful API 是现代 Web 开发中不可或缺的组成部分，它基于 HTTP 协议，通过统一的接口实现资源的创建、读取、更新和删除。以下是核心设计原则与实践指南：

一、RESTful API 的核心原则 🔐

  1. 资源导向
    所有操作都围绕资源展开，例如：

    • GET /users 获取用户列表
    • POST /users 创建新用户
    • PUT /users/123 更新用户信息
    • DELETE /users/123 删除用户

    📌 每个资源对应唯一 URI，使用名词而非动词。

  2. 状态码规范

    • 200 OK：请求成功
    • 201 Created：资源创建成功
    • 400 Bad Request：客户端错误
    • 404 Not Found：资源不存在
    • 500 Internal Server Error：服务器错误

    📌 状态码需准确反映操作结果，避免模糊描述。

  3. 无状态通信
    每次请求需包含完整信息，服务器不保存客户端状态。例如：

    • 使用 Token 认证代替 Session
    • 避免在请求头中存储用户会话数据

二、资源表示与格式 📁

  • JSON 格式：主流数据交换格式，例如： 
    {
  "id": 1,
  "name": "张三",
  "email": "zhangsan@example.com"
}
  • 超媒体（HATEOAS）：在响应中包含可操作的链接，例如： 
    {
  "id": 1,
  "name": "张三",
  "links": [
    {
      "rel": "self",
      "href": "/users/1"
    },
    {
      "rel": "delete",
      "href": "/users/1"
    }
  ]
}

三、最佳实践 ✅

  • 使用 HTTP 方法 而非自定义动作（如 GET、POST、PUT、DELETE）
  • 遵循 统一资源命名 规则（如 /products 而非 /get_products）
  • 保持 版本兼容性（如 /api/v1/users）
  • 避免 过度嵌套（如 /users/1/orders 可能改为 /users/1/orders）

四、扩展阅读 📚

RESTful_API设计