NGINX.COM
Web Server Load Balancing with NGINX Plus

本篇是有关 API Connectivity Manager 的系列博文(共两篇)的第二篇:

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 体验。

Graphic listing the four principles of API design: Identify users, Define functionality, Optimize usability, and Enhance experience

第 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 提供配套的查询、学习、测试和入门支持资源。如果没有一个涵盖基础架构、工具和文档的支持性生态系统,开发人员将很难使用您的 API。重要的考虑因素包括:

  • 基于集成式单点登录 (SSO) 的轻松登录,以及简单的 API 密钥管理
  • 全面清晰的文档,包括最新的参考资料和代码示例
  • 快速设置,基本 API 请求最好在 5 分钟内创建完成

在 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 Connectivity ManagerF5 NGINX Management Suite 的一部分,在设计时充分考虑了 API 开发人员体验。借助 API Connectivity Manager,基础架构团队可以部署高性能的 API 网关和开发人员门户。开发人员可以快速发布和管理 API 和文档,或快速发现 API 并将其集成到应用中。

API Connectivity Manager 的优势包括:

  • 快速入门——与您偏好的身份提供商整合,以简化在开发人员门户上的授权和身份验证
  • 简单的文档——当 API 所有者向 API 网关发布 API 时,使用 OpenAPI 规范自动为开发人员门户生成文档
  • 交互式学习——支持开发人员通过开发人员门户上的集成式 API 资源管理器发现、测试和学习您的 API
  • 工作流程自动化——使用完全声明式 REST API 将 API 发布和管理集成到 CI/CD 流水线中

立即免费试用

立即开启 NGINX Management Suite 30 天免费试用 ,包括 API Connectivity ManagerInstance Manager

相关资源

Hero image
《NGINX 完全指南》2024 年最新完整版


高性能负载均衡的进阶使用指南

关于作者

Rajesh Bavanantham

NGINX 产品管理总监

关于作者

Veena Raja Rathna

高级产品经理

关于作者

Andrew Stiefel

产品营销经理

关于 F5 NGINX

F5, Inc. 是备受欢迎的开源软件 NGINX 背后的商业公司。我们为现代应用的开发和交付提供一整套技术。我们的联合解决方案弥合了 NetOps 和 DevOps 之间的横沟,提供从代码到用户的多云应用服务。访问 nginx-cn.net 了解更多相关信息。