Share-API 设计最佳实践的思考

原文链接：
API 设计最佳实践的思考

整理与思考

前言

里面有一句话特别好，成功的系统不是有一些特别闪光的地方，而是设计时点点滴滴的努力积累起来的。

范围

讨论一个问题需要明确其针对的范围。

API设计准则

首先总结了基础性原则，基础性原则即是那些如果我们遵守了就可以让API在以后的演进过程中避免多数设计问题的原则。

• 提供清晰的思维模型
• 简单is simple
• 容许多个时间

最佳实践

POSIX File API

• Document Well 写详细的文档
• Choose the right level of the abstraction 选择合适的抽象层
• Naming and identification of the resource 命名与标识
• Conceptually what are the meaningful operations on this resource? 对于该对象来说，什么操作概念上是合理的？
• For update operations, prefer idempotency whenever feasible 更新操作，尽量保持幂等性
• Compatibility 兼容
• Batch mutations 批量更新
• Be aware of the risks in full replace 警惕全体替换更新模式的风险
• Don’t create your own error codes or error mechanism 不要试图创建自己的错误码和返回错误机制

以上便是这篇文章的主要结构，另外
提供两个参考链接
Google Cloud API Guide

Microsoft API design best practices

最后再附上一篇相关的infoq文章供大家学习
人人都是 API 设计师：我对 RESTful API、GraphQL、RPC API 的思考