应用程序编程接口 (API) 已成为科技界的热门词汇。越来越多的组织正在理解开发 API 计划以实现其战略目标的实际意义。在这种情况下，以对潜在用户和客户有意义的方式更好地宣传 API 的价值和优势非常重要。 我有机会与Jennifer “Jen” Riggins（营销顾问和 eBranding Ninja 的技术故事讲述者）eBranding Ninja坐下来，讨论 API 从业者之间存在的文化。 Jen 是 API 领域杰出的营销人员和品牌顾问。作为 API 社区中为数不多的没有接受过正规技术培训的故事讲述者之一，她对 API 领域存在的文化提供了独特的视角，并讨论了向广大受众讲述 API 故事的重要性。
API 创新的文化
Jen 认为，过去十年中，人们对 API 的兴趣获得了很大的发展势头，并且将在塑造我们的未来中发挥重要作用。API之所以成为主流，部分原因是 API 社区为了宣扬和提高人们对投资 API 经济的好处的认识所做的努力。这个社区由 API 供应商、从业者和消费者组成，以开放和协作为宗旨，这导致了 API 领域的重大发展。 开放、透明和求知欲的融合造就了创新文化。这也促成了在短时间内渗透到 API 领域的新技术数量的增长，从 API 定义格式（如OpenAPI 规范）到新架构（如超媒体和 Graph）。这种普遍的协作文化反映了开源社区，因为很大一部分 API 从业者都起源于开源项目。为了促进协作和加快工程进度，诸如SwaggerHub之类的 API 开发平台提供了有利于团队一起设计和记录健壮 API的功能。“技术领域的普遍趋势是赋予开发人员更多权力，在软件项目上进行更多协作。这是开源社区的基础，现在在 API 社区中也看到了这一点，” Jen 说。 她说，API 社区非常热情和友好，让成员可以在此过程中学习和成长。参与开发和集成 API 的人员来自不同的背景和技能，这为对话带来了不同的观点。Jen 还观察到，随着 API 意识的提高，社区的地域范围也在扩大。 “这是一个非常虚拟的社区。这部分是因为技术本身的性质，部分是因为它起源于开源社区。” 随着 API 领域竞争的加剧，这种文化可能会发生变化。科技巨头在发布 API 文档和管理解决方案方面的投资大幅增加，这可能会对 API 社区所代表的开放和透明的普遍文化产生影响。
为什么 API 需要优秀的故事讲述者
Jen 提出了 API 行业缺乏良好营销的一个重要观点。营销是向正确的受众讲述正确的故事，以帮助他们使用您的产品获得成功。既然 API 的业务模式已经建立，那么关注您如何有效地向目标市场讲述 API 的故事非常重要。由于 API 一直具有技术倾向，因此大多数开发人员在营销 API 时关注其 API 的核心技术而不是业务价值。 “目前，该行业面临的最大痛点是沟通。从根本上说，开发人员仍然不擅长推广他们的 API 并将其转化为更广泛的受众。API 开发人员和供应商需要向潜在客户传达其 API 的业务价值以及它将如何使他们受益。” Jen 继续说：“许多 API 文档和营销甚至省略了 API 帮助用户完成什么的基本摘要。” 她引用了Andrew Seward几年前在 APIdays 上的一次演讲，他要求听众花一分钟时间互相描述他们的 API。 “人们立即开始描述驱动这些 API 的语言和架构，完全忽略了它背后的业务价值，”Jen 说。 组织仍在努力解决的一个大问题是理解他们的核心受众。API 的目标受众仅仅是精通技术的开发人员，他们会尽一切努力与您的 API 集成的日子已经一去不复返了。API 的受众已扩展到产品经理、技术作家和营销人员，他们希望使用通过 API 分布的服务来解决特定问题。如果 API 的价值和服务如何帮助解决目标受众的痛点不明确，那么它将对其采用产生不利影响。API 的目标受众现在包含更大一部分角色，因为 API 已成为业务驱动因素，在讲述 API 的故事时对这些角色感同身受是您成功的关键组成部分。 API 影响者正在将对话引导至从业务角度将 API 服务的价值有效转化为面向客户的消息传递的想法。一旦人们确定了业务价值，就可以更好地缓解 API 采用和追加销售的问题。 “良好的营销必须从成为您自身业务和部门内部更好的倡导者开始，然后才能在 API 社区之外进行倡导。我们在技术领域宣扬和推广 API 的好处方面做得非常出色，现在是我们向世界其他地方讲述这个故事的时候了，” Jen 说。 Jen 认为，API 社区需要自己的明星，他们讲述的故事能够与世界其他地方产生共鸣。像Kin Lane (API Evangelist)、Lorinda Brandon 和Arnaud Lauret (API Handyman)等人一直在积极地向非技术受众推广投资 API 计划的好处，但 Jennifer 认为我们需要更多。她说，我们不仅必须更好地营销 API，而且还必须更好地在社区内部营销彼此，以便提高人们对 API 经济好处的认知度。
API 文档是您故事的延伸
API 文档是您整体 API 信息的延伸，其重点是为您的消费者提供所有正确的资源，以便他们开始并成功地与您的 API 集成。Jen 认为，此信息必须渗透到您 API 产品的所有方面，而文档是此信息不可或缺的一部分。良好的文档可以满足您所有目标受众的需求，并且由于您的受众不仅仅局限于 API 经济中的开发人员，因此务必优先考虑并相应地优化您的文档。 但文档一直是 API 生命周期中最不受重视的步骤，尽管它是 API 采用的最大转化点，正如 Jen 在研究她的 2017 年 API 文档状态报告时发现的那样。 相关链接：关于构建可优化开发者体验的文档的免费在线研讨会 “在采访了数十位 API 影响者并撰写了有关 API 文档的行业报告之后，真正有趣的是文档中对人情味的需求。在短时间内，人们对从 API 生成 Swagger 文档 感到满意，但很快意识到还需要更多。目前，对能够同情营销过程中真正的人性化问题的技术作家有很大的需求。” 通过与众多从业者的交谈，Jen 认为，开始 API 文档流程的最佳方法是为您的 API 生成规范，这将是具体且强大的文档的基础。这可以使用任何流行的框架，如 Swagger 或 API Blueprint。对于基于遗留系统的 API，始终存在生成定义的问题，您可以 查看我们的免费资源，了解有关克服此问题的一些好的解决方案。生成此定义绝不是最后一步。文档始终需要人情味，并且必须演变为全面的使用手册，指导用户完成 API 采用过程的每个阶段。文档可以被视为一种产品，Jen 重申，定制您的信息和 API 文档以解决客户必须解决的总体场景，可以极大地提高用户满意度。 “人们正在 Google 上搜索您的 API，阅读您 API 的价值主张和文档，如果他们无法开始使用您的 API，他们将转而使用其他人的 API。” 她认为，要构建一流的文档，它必须成为 API 开发过程的一部分。Gareth Jones，Microsoft Graph API 的首席架构师，在 之前的对话 中也呼应了这一点，即首先记录客户在使用您的 API 时可能面临的总体场景，以此开始开发过程。通过这种文档或规范优先的方法，组织可以开始与各种试点客户讨论如何改进这些资源，以增加 API 的使用量。将您的 API 文档视为单独的一流服务，帮助消费者更快地与您的产品集成，这应是一个战略重点。
行业的未来
Jen 认为，API 将引领许多新技术，如人工智能和物联网。由于它们的互联互通性，API 将成为许多新创新的支柱。 “所有正在发生的闪亮新事物，API 都是其支柱。物联网、人工智能、机器学习和 AR（增强现实）都将通过 API 以某种方式提供服务。不断涌现出各种各样的创新，而 API 处于这些创新的中心，”她说。 随着 API 经济的到来，以及新技术以前所未有的速度涌现，对有效的故事讲述的需求只会增加。 我对 Jen 的采访是一系列 API 专家访谈的一部分。您希望我们与 API 专家探讨哪些主题？请在下面的评论中告诉我们，或在 Twitter 上 @我们：@SwaggerHub。