RESTful API 是一种基于 HTTP 协议的架构风格，通过标准的 HTTP 方法（如 GET、POST、PUT、DELETE）实现对资源的增删改查。以下是关键要点：

核心原则 ✅

  • 资源导向：每个 URL 对应一个资源（如 /users 表示用户集合）
  • HTTP 方法：
    • GET：获取资源（例如 /api/products/123）
    • POST：创建新资源（例如 /api/orders）
    • PUT：更新资源（例如 /api/users/456）
    • DELETE：删除资源（例如 /api/products/789）
  • 状态码规范：
    • 200：成功
    • 404：未找到
    • 500：服务器错误

最佳实践 🛠

  • 使用 名词复数 表示集合（如 /api/books 而非 /api/book）
  • 通过 查询参数 过滤数据（如 /api/users?role=admin）
  • 遵循 统一接口，避免自定义端点
  • 添加 版本控制（如 /api/v1/users）

扩展阅读 📚

点击了解 API 设计规范
查看 RESTful API 示例代码

restful_api