应用程序编程接口 (API) 已成为科技界的热门词汇。越来越多的组织正在理解开发 API 程序以实现其战略目标的实际意义。在这种背景下，以一种对潜在用户和客户有意义的方式更好地推广 API 的价值和优势至关重要。 我有机会与 Jennifer “Jen” Riggins，她是一位营销顾问兼 eBranding Ninja 的技术故事讲述者，就 API 从业者之间存在的文化进行了交流。Jen 是 API 领域一位杰出的营销和品牌顾问。作为 API 社区中少数没有正式技术培训的故事讲述者之一，她对 API 领域存在的文化提供了独特的见解，并讨论了向广大受众讲述 API 故事的重要性。
API 创新文化
Jen 认为，在过去十年中，对 API 的兴趣获得了巨大发展，并将对我们的未来发挥重要作用。API 之所以普及，部分原因在于 API 社区努力宣传和提高人们对投资 API 经济的益处的认识。这个由 API 供应商、从业者和消费者组成的社区以开放和协作为核心，这使得 API 领域取得了显著发展。 开放、透明和求知欲的融合造就了一种创新文化。这也促成了短时间内渗透到 API 领域的新技术数量的增长，从像 OpenAPI 规范 这样的 API 定义格式，到像 超媒体 和图这样的新架构。这种普遍的协作文化是开源社区的体现，因为大部分 API 从业者都植根于开源项目。为了促进协作并加速工程，像 SwaggerHub 这样的 API 开发平台提供了 有利于团队共同设计和文档化健壮 API 的功能。 Jen 说：“技术领域有一个普遍趋势，即赋予开发人员更多权力，在软件项目中进行更多协作。这是开源社区的基础，现在也正在 API 社区中出现。” 她说，API 社区一直非常热情和友好，让成员在这个过程中学习和成长。有来自不同背景和技能组合的人们参与 API 的开发和集成，这为对话带来了多样化的观点。Jen 还观察到，随着 API 意识的增长，社区的地理范围也在扩大。 “这是一个非常虚拟的社区。这部分是由于技术本身的性质，部分是由于其根植于开源社区。” 随着 API 领域竞争的加剧，这种文化可能会发生变化。科技巨头对发布 API 文档和管理解决方案的投资大幅增加，这很可能会对 API 社区所代表的普遍开放和透明文化产生影响。
为什么 API 需要优秀的叙事者
Jen 提出了 API 行业缺乏良好营销的一个重要观点。营销在于向正确的受众讲述正确的故事，以帮助他们使用您的产品成功完成任务。既然 API 的商业模式已经确立，关注如何有效地向目标市场讲述 API 的故事就显得尤为重要。由于 API 始终带有技术色彩，大多数开发人员在营销 API 时都专注于其核心技术而非商业价值。 “目前行业面临的一大痛点是沟通。归根结底，开发人员在推广其 API 并将其传达给更广泛的受众方面仍然相当糟糕。API 开发人员和供应商需要向潜在客户传达其 API 的商业价值以及它将如何使他们受益。” Jen 继续说道：“许多 API 文档和营销甚至省略了 API 帮助用户实现什么的基本概述。” 她引用了几年前 Andrew Seward 在 APIdays 上的一次演讲，他要求听众花一分钟时间互相描述他们的 API。 Jen 说：“人们直接跳到描述驱动这些 API 的语言和架构，完全跳过了其背后的商业价值。” 组织仍然面临的一个大问题是理解其核心受众。API 的目标受众仅仅是那些不惜一切代价与您的 API 集成的技术娴熟的开发人员的日子已经一去不复返了。API 的受众已扩展到产品经理、技术文档工程师和营销人员，他们希望使用通过 API 分发的服务来解决特定问题。如果 API 的价值和服务以及它如何帮助解决目标受众的痛点不明确，那么它将对其采用产生不利影响。API 的目标受众现在包含更大一部分的用户画像，因为 API 已成为业务驱动力，因此在讲述 API 故事时对这些用户画像保持同理心是您成功的关键组成部分。 API 影响者正在将对话转向有效将 API 服务的业务价值转化为面向客户的信息的理念。一旦人们识别出商业价值，API 采用和追加销售的问题就能更好地缓解。 Jen 说：“良好的营销必须从在您自己的业务和行业中成为更好的倡导者开始，然后才能在 API 社区之外进行倡导。我们在技术领域宣传和推广 API 的益处方面做得非常出色，现在是时候向世界其他地区讲述这个故事了。” Jen 认为 API 社区需要自己的明星来讲述能与世界其他地区产生共鸣的故事。像 Kin Lane (API 布道师)、Lorinda Brandon 和 Arnaud Lauret (API 勤杂工) 这样的人一直在积极向非技术受众推广投资 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。