Read the latest article and comment on Notion.

API Improvement Proposals

• API 的大致分类

  • Standard methods: GET / List / Create / Update / Delete
  • Standard methods 和其他methods 的 batch operations
  • Standard methods 和其他methods 的 long-running operations
  • Jobs 接口
  • Import and export 数据接口
  • item method / collection method / db method / stateless method

  特殊接口

  • Revision 接口，一个资源的历史记录，之所以叫’revision’，是为了和API 的‘version’ 区分开

    • get，记得在返回的name 里加上revision id。

    • tag，给一个revision 加上human readable 的标签，之后revision id 和tag 都能用来get revision。