API 设计概要

关于 API 设计文章太多太多,这里不赘述,仅“点”一下,具体的查看文末资源。

  • 数据建模(Data-oriented),而非功能建模(Function-oriented)
  • 所有事物抽象为资源,URI 是唯一标识(定位资源)
  • 使用 HTTP Methods 操作资源
  • 资源操作安全性、幂等性
  • 检索对象资源
  • 检索对象结构资源(数据集合)
  • 检索对象子资源
  • 数据分页
  • 实体关联:查询参数,或URL 层级路径
  • 参数进行编码
  • 标识缓存性
  • 无状态
  • URI:名词(资源可与数据库表名对应),小写,-,资源集合用复数,
  • 使用 HTTPS
  • API 作为子域名
  • 身份认证:OAuth2.0, JWT
  • 数据格式
  • 不要试图创建自己的错误码和返回错误机制
  • 不要试图变相使用 HTTP Methods 实现额外功能
  • 应用层添加错误追踪机制


另外一种API设计方式——GraphQL

发布了110 篇原创文章 · 获赞 53 · 访问量 37万+

猜你喜欢

转载自blog.csdn.net/xianghongai/article/details/90813812
今日推荐