RESTful API 设计要点

  • 谨慎使用数据库的自增 ID 作为资源 ID,防止网络爬虫

  • JSON 比 XML 有更丰富的类型,XML 中的一切都是字符串

  • 使用复数名词表示端点(Endpoint)更具有一致性,例如:
    GET /users 返回全体用户列表
    GET /users/user_id 返回某个用户的信息

  • 不要使用动词表示端点,因为 HTTP Method 已经是一个动词

  • 用 POST 表示创建新的资源,用 PUT 表示替换某个已有资源的全部内容。PUT 是幂等(Idempotent)操作,而 POST 不是

  • 用 DELETE 表示删除已有资源,DELETE 操作也是幂等的(虽然有副作用)

  • 在 API 返回错误时,不要使用 200 状态码,而应该使用 HTTP 协议中定义的错误代码

  • 在 API 返回的数据中提供自定义的更精确的错误码、错误类型和错误消息

  • 一次只返回一个错误,以简化设计

你可能感兴趣的:(RESTful API 设计要点)