文本比较工具开放式api_建立成功的开放式Web API的提示

文本比较工具开放式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 。

翻译自: https://opensource.com/business/16/3/tips-building-successful-open-web-api

文本比较工具开放式api