RESTful API 是一种基于 HTTP 协议的架构风格，强调简洁性、可扩展性和资源导向。以下是设计 RESTful API 的核心原则：

✅ 核心原则

  1. 使用标准 HTTP 方法

    • GET：获取资源
    • POST：创建资源
    • PUT：更新资源
    • DELETE：删除资源
    • PATCH：部分更新资源
    HTTP_Methods

  2. 统一资源标识符 (URI)

    • 资源应通过名词表示，如 /users 而非 /get_users
    • 避免嵌套过深，保持简洁
    RESTful_API

  3. 状态码规范

    • 200 OK：请求成功
    • 201 Created：资源创建成功
    • 400 Bad_Request：客户端错误
    • 404 Not_Found：资源不存在
    • 500 Internal_Server_Error：服务器错误
    Status_Code

  4. 无状态通信

    • 每次请求需包含完整信息，避免依赖服务器会话
    • 使用 Token（如 JWT）进行身份验证

📌 示例

GET /api/v1/users/123 HTTP/1.1
Accept: application/json

响应示例：

{
  "id": 123,
  "name": "张三",
  "email": "zhangsan@example.com"
}

🔗 扩展阅读

📌 提示：设计时注意资源层级逻辑，避免使用动词（如 /create_user）以保持一致性。

API_Design