0

我需要说服管理层（产品管理和其他），与创建公共 API 候选者的最佳实践相比，仅“公开”内部私有 API 是一个坏主意，在内部使用它并在满意时将其公开。谁能帮我找到一些事实，比如帮助我提出论点的研究论文？

4

1 回答 1

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 Format Rest vs WebServices
  • 响应格式 XML、JSON
  • 服务合同说明
  • API 消费者的身份验证机制
  • 服务版本控制（这样您就可以推出新版本的 API 而不会让所有人都崩溃）
  • 速率限制（显然，对于任何数量的事情，防止 DOS 攻击，并且只管理系统负载）
  • 文档
  • 辅助库
  • 公共 api 的网站
  • 取决于它是什么类型的 API... 支持团队

这也没有解决您的内部流程。您的内部系统是否应该能够比公共 api 发展得更快？在大多数情况下，我认为答案是肯定的，因为您的公司希望对其业务模式和战略保持敏捷。让第 3 方使用您的内部系统将迫使您的公司做出决定，在需要进行更新时谁更重要。您的公司要么必须对其内部服务进行版本化，并希望第三方消费者及时升级，要么只是中断所有第三方消费者的集成。

归根结底，这可能不值得做。您只能在使用您的 API 的人停止使用它之前多次使用它。如果没有人使用它有什么好处。

在企业希望 API 推出太快且没有围绕它的任何治理之前，我一直处于这样的位置。这导致我所有的时间都花在支持与我们的 API 集成的人们，并为他们编写代码示例。

于 2010-12-17T13:58:58.203 回答