请求设计规范

  • URI 使用名次，尽量使用复数，如 /users
  • URI 使用嵌套表示关联关系，如 /users/12/repos/5
  • 使用正确的 HTTP 方法，如 GET/POST/PUT/DELETE
  • 不符合 CRUD 的情况：POST/action/子资源

相应设计规范

  • 查询
  • 分页
  • 字段过滤
  • 状态码
  • 错误处理

安全

  • HTTPS
  • 鉴权
  • 限流

开发者友好

  • 文档
  • 超媒体