原文在这里。

不断尝试完善其API策略的团队经常会讨论一个话题——什么是设计良好的API设计。在之前的一篇博文中,我简要讨论了API设计的重要性。良好设计的API包含如下好处:改善开发者体验、快速形成文档、提高你的API的采用率。但是好的API设计到底有哪些内容呢?在这篇博文里,我将细化一些RESTful风格API设计的最佳实践。

良好设计的API的特征

一般来说,一个有效的API设计将拥有如下特征:

  • 易读易用:一个设计良好的API应该是易于使用的;它表达的资源与关联的操作应该可以被经常使用它的开发者快速记住。
  • 很难误用:实现或集成一个设计良好的API应该是一个简单的过程,而写出错误代码应该是一个不太可能的结果。