API 开发人员体验为何如此重要

这是有关 API 连接管理器的两部分系列文章中的第二篇：

• 5 种应对 API 蔓延的方法（以及您应该关注的原因）
• 为什么 API 开发人员体验如此重要——这篇文章

API 是现代商业的核心。 虽然 API 在软件开发中一直扮演着重要的角色，但对数据集成的不断增长的需求导致 API 在各个业务线得到更广泛的采用。 但 API 的作用不仅仅是连接数据和应用——它们对于与外部业务伙伴合作、向客户提供服务以及作为产品本身创造收入也至关重要。

开发人员在 API 经济的中心扮演着关键的角色。 负责构建、集成和维护 API，他们既是 API 的创建者，也是技术采用者。 他们的经验（通常称为API 开发人员经验）是决定 API 整体成功与否的最重要因素之一。本文探讨了 API 开发人员经验的关键概念以及 IT 领导者在规划 API 经验时需要考虑的事项。

1. API 开发人员体验如何？
2. 为什么 API 开发人员体验很重要？
3. 如何打造出色的 API 开发人员体验？

API 开发人员体验是什么？

API 开发人员体验描述了开发人员与 API 交互时的整体感知和情绪。它涵盖了基础设施、工具、流程、支持和其他接触点，这些有助于开发人员在将 API 集成到其应用中时获得愉快且顺畅的体验。 API 开发人员体验是整体开发人员体验的一个子实践。

为什么 API 开发人员体验很重要？

如果说对用户体验的不懈关注推动了第一代技术创新，那么下一代成功的公司将会因注重开发人员的体验而获得胜利。

随着 API 经济的不断扩张，开发人员对采用哪些 API 的影响力越来越大。 当 API 难以发现、缺乏足够的文档或维护不善时，开发人员会放弃它，而选择更简单、更快的替代方案。 这同样适用于内部 API 程序以及合作伙伴和客户的外部 API。

对于外部 API，当开发人员放弃您的 API 时，会产生切实的业务后果。您不仅会失去来自直接客户的收入，还会失去对客户使用的更广泛的产品和解决方案生态系统的访问权限。 即使是内部 API 程序也会因开发人员体验不佳而面临后果，包括产品上市时间变慢、开发人员工作效率降低、返工增加，这些都可能危及您的业务成功。

为了在以开发人员为中心的世界中取得成功，您需要一个 API 策略，为 API 生命周期每个阶段的开发人员提供正确的工具和资源。 实现此目标的最佳方式是为开发人员创建周到的端到端API 体验，涵盖三种类型的 API 使用：

• 部署和管理 API
• 发现和测试 API
• 监控和保护 API

如何打造出色的 API 开发人员体验？

创造积极的体验需要了解开发人员如何使用您的 API、他们需要什么来完成任务，以及最终他们在使用您的 API 时的感受。一旦您定义了将与您的 API 交互的角色，您就可以开始规划整体 API 体验。

设计 API 开发人员体验时需要考虑四个原则：

1. 识别用户——谁在与 API 交互？
2. 定义功能——API 有什么作用？
3. 优化可用性——API 使用起来有多容易？
4. 增强体验——使用 API 的感觉如何？

让我们看看每个原则以及您需要提供什么才能为开发人员创建最佳 API 体验。

步骤 1： 识别用户

正如您针对特定客户问题设计产品一样，您需要设计跨基础设施和产品的 API 体验来解决开发人员的顾虑。 开发人员不仅仅是最终消费者，他们还是整体基础设施的建设者和维护者。

在设计 API 开发人员体验时需要考虑三个主要角色：

• API 使用者– 发现、实施和维护其应用的 API 集成
• API 所有者– 规划、构建、记录、测试、部署和管理其服务的 API
• 基础设施管理员——制定全局策略并监控 API 的安全性和合规性

您可能需要考虑其他用户和利益相关者。 例如，API 消费者类别可能包括内部开发人员、合作伙伴和客户等子类别，每个类别都有不同的角色和要求。

第 2 步： 定义功能

功能是成功 API 的基础。 良好的 API 使开发人员能够集成有价值的数据或服务，更快地完成任务，并减少开发新功能所花费的总体时间。 主要考虑因素包括：

• API 通过与数据或服务集成可以提供什么价值？
• API 通过减少调用和结构化数据如何很好地解决问题？
• 就可用性、可靠性和可扩展性而言， API 的可靠性如何？

API 的功能与 API 优先的开发方法紧密相关。 与“代码优先”相反，“API优先”是在代码开发开始之前编写API规范，重点是API请求的结构和返回的数据。 这种强调确保了 API 始终如一地提供开发人员所需的价值和功能。

步骤3： 优化可用性

第三个原则，可用性，涉及开发人员如何使用您的 API，而不是他们可以用它们做什么。 它涵盖了支持发现、学习、测试和入职的 API 资源。 如果没有基础设施、工具和文档的支持生态系统，开发人员将难以使用您的 API。 重要的考虑因素包括：

• 通过集成的单点登录 (SSO)轻松注册并轻松管理 API 密钥
• 清晰、详尽的文档，包含最新的参考资料和代码示例
• 设置时间快，创建基本 API 请求理想情况下只需不到五分钟

在 Postman 的2022 年 API 状况报告中，调查受访者表示使用 API 的主要障碍是：

• 缺乏文件（55%）
• 难以发现 API（38%）
• 缺乏基本的 API 知识（30%）

您可以利用具有详尽文档、代码示例和试用 API 的工具的中央开发人员门户来克服这些问题。

步骤4： 增强体验

API 开发人员体验是 API 消费者和 API 所有者之间交互的总和。 基础是建立在 API 的功能和可用性之上的，但还有其他交互可以提升使用 API 的整体乐趣。这些交互包括：

• 活跃的社区可在 Stack Overflow、Slack、Discord、Twitter 等渠道上找到。
• 开发团队提供及时响应的支持
• 与 API、文档和社区交互时的顺畅体验

喜欢使用您的 API 的开发人员更有可能向他们的同事推荐它们、围绕它们构建新的功能并将其集成到他们的应用程序中。

API 开发人员体验至关重要

出色的 API 开发人员体验的关键包括您的 API 以及围绕它的工具、流程、文档和支持的生态系统。 当您的 API 生态系统的所有部分无缝运行时，它们会减少摩擦和复杂性，因此开发人员可以专注于构建应用。

上面讨论的步骤是设计、实施、测试和评估 API 开发人员体验的持续过程的一部分。 如果您专注于每个主要步骤 - 识别用户、定义功能、优化可用性和增强体验 - 您可以构建令人愉快甚至有趣的 API。

NGINX 如何改善 API 开发人员体验？

API 连接管理器是F5 NGINX 管理套件的一部分，其设计核心是 API 开发人员体验。 借助 API Connectivity Manager，基础设施团队可以部署高性能 API 网关和开发人员门户。 开发人员可以快速发布和管理 API 和文档，或者发现并将 API 加入到应用中。

API 连接管理器的优势包括：

• 快速入职——与您最喜欢的身份提供商集成，以简化开发人员门户上的授权和身份验证
• 简单的文档——当 API 所有者将 API 发布到 API 网关时，使用OpenAPI 规范自动为开发人员门户生成文档
• 交互式学习——使开发人员能够通过开发人员门户上的集成 API 探索器发现、测试和学习您的 API
• 工作流自动化——使用完全声明式 REST API 将 API 发布和管理集成到 CI/CD 管道中

立即开始

开始30 天免费试用NGINX 管理套件，其中包括API 连接管理器和实例管理器。

相关资源

• 博客： 使用 F5 NGINX 管理套件连接、扩展和保护应用程序和 API
• 博客： 应对 API 蔓延的 5 种方法（以及您应该关注的原因）
• 解决方案简介： NGINX 管理套件 API 连接管理器