API设计指南

第一、设计原则

  1. 必须使用 TLS(https)
  2. 请求和响应都要带有版本号
  3. 支持缓存
  4. 给每个请求都分配一个 Request-ID
  5. 响应的大小要有限制

第二、请求的设计

  1. 每个请求要有身份验证
  2. 对请求进行限流和限速

第三、响应的设计

  1. 每一个响应都要有合适的状态码
  2. 每个响应至少包含状态码、消息提示和数据体