构建成功的开放 Web API 的技巧

Web API 在行业中已变得无处不在，但许多组织仍在努力创建对开发者具有吸引力和参与度的平台。创建开发者想要使用的 API 并非易事，它需要周密的计划和实施，以及对与客户端开发者沟通的认真思考。此外，API 的设计需要以开发者为中心——开发者体验是首要任务。

强大的 Web API 为公司提供了非常具体且易于理解的商业价值，无论是增加使用量、巩固合作伙伴集成，还是使新应用程序能够访问其系统。无论该商业价值是什么，都应清晰且一致地传达给开发者社区。了解平台目标的开发者将更好地理解他们可以并且应该如何利用该平台与组织协同工作。同样，需要为客户端开发者概述目标用例，并提供清晰的教程、示例代码和有效的支持。

许多公司仍然难以摆脱对失去知识产权的担忧。与其担心分享平台信息的危险，组织不如扭转话题，并向开发者传达一切信息，以加强其平台并招募开发者作为其平台的布道者。

另一方面，对开发者隐瞒这些信息会导致他们尝试寻找自己的方法。通常，这可能导致客户端以不受支持的方式使用 API，或者开发者创建的客户端不符合组织的产品目标。

这种沟通是吸引人的 API 的基石之一。虽然过去的系统在信息保密的情况下运行良好，但无论您是否直接分享，Web API 都将公开有关您系统的的大量信息。花时间向使用该平台的开发者解释您的平台目标和理想。将这些开发者视为您的合作伙伴，而不是潜在的竞争对手。

还有什么使 Web API 具有吸引力？周全的设计。成功的 API 将在考虑用例的情况下创建——这些特定任务应该易于通过 API 完成，文档清晰，并且任何 API 客户端开发者都可以理解。为了创建一致的平台，最好在编写代码之前花时间对模式进行建模。模式模型提供了 API 的人类可读描述，适合与产品经理、其他团队甚至将使用 API 的客户进行讨论。

出色的 Web API 还将提供开源示例代码、帮助程序库和示例应用程序，供开发者用作构建块。API 入门越容易，开发者就越有可能参与到平台中并创建强大的客户端应用程序。开源是一件了不起的事情，用出色的代码播种您的社区将鼓励其他开发者为生态系统添加自己的贡献。在一个表单中很好地回答问题将会结出硕果，因为您的开发者开始回答其他开发者的问题，从而进一步加强您的社区。

创建出色 API 的道路可能有很多种形式，但有一些指导原则应始终遵循。平台可用性应始终是至关重要的——力求提供最佳的开发者体验。文档需要完整，包括教程和指南，以帮助开发者快速入门并运行。最重要的是，与客户端开发者共享的信息应始终清晰、一致和完整，以便这些有价值的合作伙伴可以与平台团队合作，共同创建一个出色的一流 API。

我将在 2016 年 3 月 16 日至 17 日在 Great Wide Open 大会上就 吸引人的 API 发表演讲。