问在哪里可以找到证明创建公共API的最佳实践的研究数据？

EN

我不知道有任何具体的研究，因为任何API的公共接口都是高度主观的，并且特别与问题域联系在一起。

这篇pdf的前几页是对业务人员API的一个ok概述：http://aarontgrogg.com/wp-content/uploads/2009/09/How-to-Build-API-and-why-it-matters.pdf。

这篇博客发布了部分标题的重点，你的业务伙伴需要考虑的要点，我想你已经知道了。我将搜索这些特定主题的最佳实践，因为它们与公共API相关：http://gaejexperiments.wordpress.com/2010/07/01/public-api-design-factors/

JSON格式Rest与WebServices

• Response格式XML，JSON服务合同描述

• Authentication机制

• Documentation

• Helper Libraries

• Website api

• Depending
• 服务版本控制(这样您就可以推出新版本的
• 服务，而不会把每个人都炸飞)
• 速率限制(显然，对于任何数量的事情，都是为了防止DOS攻击，并且只是管理系统负载)
• Documentation
• Helper Libraries
• Website
• 是什么类型的接口...A SUPPORT TEAM

这也没有涉及到你的内部流程。您的内部系统应该能够比公共api发展得更快吗？在大多数情况下，我认为答案是肯定的，因为您的公司希望灵活地使用他们的商业模式和战略。让第三方使用你的内部系统将迫使你的公司在进行更新时决定谁更重要。要么你的公司将不得不对其内部服务进行版本化，并希望第三方消费者及时升级，要么直接破坏所有第三方消费者的集成。

归根结底，这可能不值得去做。在人们停止使用你的API之前，你只能欺骗他们这么多次。如果没有人使用它又有什么用呢？

我以前也遇到过这样的情况，企业希望API推出得太快，而且没有任何治理。这导致我所有的时间都花在支持那些与我们的API集成的人，并为他们编写代码样本。