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

Question

我需要说服管理（产品管理和其他人），与创建公共API候选人的最佳做法相比，仅仅“公开”内部私有API是一个坏主意，在内部使用它并在满意时将其公开。任何人都可以帮我找一些事实，比如研究论文可以帮助我做出论证吗？

Answer 1

我不知道任何特定的研究，因为任何API的公共接口都是高度主观的，并且特别与问题域相关联。

此pdf的前几页是商务人士API的概述： 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/

• API格式Rest与WebServices
• 响应格式XML，JSON
• 服务合同说明
• API消费者的身份验证机制
• 服务版本控制（因此您可以推出新版本的API而不会让所有人都知道）
• 速率限制（显然，对于任何数量的事情，防止DOS攻击，只是管理系统负载）
• 文档
• 帮助程序库
• 公众api的网站
• 取决于API的类型......支持团队

这也不能解决您的内部流程问题。您的内部系统是否能够比公共API更快地发展？在大多数情况下，我认为答案是肯定的，因为您的公司希望熟悉其业务模式和战略。让第三方消耗您的内部系统会迫使您的公司在做出更新时决定谁更重要。您的公司必须对其内部服务进行版本控制，并希望第三方消费者及时升级，或者只是打破所有第三方消费者的集成。

在一天结束时，可能不值得这样做。在停止使用API​​之前，您只能多次使用您的API。如果没有人使用它会有什么好处。

我之前一直处于这样一个位置，即企业希望API推出速度过快且没有任何治理。这导致我花了很多时间来支持那些与我们的API集成并为他们编写代码示例的人。