所有文章 > API设计 > 通过网关为API利益相关者铺平一条平坦的道路
通过网关为API利益相关者铺平一条平坦的道路

通过网关为API利益相关者铺平一条平坦的道路

我们最近对也在使用 API 网关的客户进行了调查,并与其中一些人详细讨论了他们在 API 程序中使用的工具和流程。 这些用户在许多不同的垂直市场、不同规模的团队以及处于各个成熟阶段的公司中工作。尽管如此,无论是公司还是产品,技术领导者所看重的一些不变的主题仍然给我们留下了深刻的印象——工具需要是专门设计的、低摩擦的、可供技术和非技术利益相关者使用的,并且随着时间的推移是可靠的。

至于为什么这些原则被如此广泛地共享,我们认为可以归结为一个非常简单的事情:良好的开发人员体验是良好的 API 产品设计的结果,而这需要支持您的工作的工具。当您将有效的工具、设计优先原则和产品思维结合起来时,您将获得更流畅、更高效的开发人员和用户体验。

如何使用通用设计原则构建适应性强的 API?

如果您从未听说过“遏制效应” ,那么您几乎肯定是其受益者。当公交车站和人行横道首次强制设置轮椅坡道时,各种各样的人都受益了——推着婴儿车的父母、推着手推车的送货司机,以及拖着行李去机场的人们。它已成为对某一群体所做的改进通常如何为整个社会带来好处的简写。

API是否有限制?您可以对 API 程序进行哪些更改以使它们更易于访问?这样你能获得一些意想不到的好处吗?毫不奇怪,我们认为这是可能的——并且设计优先的 API 是实现这一目标的途径。

最普遍的无障碍方法之一是通用设计。它是一套产品和通信原则,旨在让尽可能多的人在最广泛的情况下可以访问和使用。 UD 的全部范围超出了我们在这里的时间,并且某些原则与软件开发不太相关。但值得深思的是:UD 的目标——构建可用且足够灵活的产品和程序,以满足不同用户的需求——绝对适用于 API 产品团队。

您无法准确预测谁将使用您的 API 或他们将如何使用它们,甚至无法预测谁将构建它们。 UD 原则可以帮助您创建具有耐用性、灵活性和吸引力的 API 程序。问自己以下有关 API 的问题:

  1. 公平使用:我们是否提供欢迎所有潜在用户的 API 入口点?我们可以在哪里消除障碍?
  2. 使用灵活性:我们是否支持 API 消费者获得成功的多种途径?或者我们是否在不需要的地方规定了单一方法?
  3. 使用简单直观:用户是否容易理解我们的 API 的用途?找到您需要的工具是否容易?我们是否明确了安装和授权流程?
  4. 可感知的信息:我们的文档是否使用简单的语言,并提供清晰的功能示例和可导航资源?我们对用户已经知道的内容做出什么假设?
  5. 错误容忍度:不遵循我们首选路径的用户会发生什么?我们是否在应用程序中提供有用的错误消息?我们有支持故障排除的文档吗?
  6. 低(物理)工作量:我们是否提供简单的方法来探索、测试功能和构建试用集成?身份验证过程是否快速且可预测?用户的痛点在哪里?我们是否在用户流程中的任何地方造成了不必要的认知负担?
  7. 方法和使用的大小和空间:我们的 API资源可以与屏幕阅读器一起使用吗?它们的视觉组织方式是否适合低视力用户管理?

API 为公共安全提供可靠、创新的 GIS 数据。

从 1995 年开始, GeoComm的创始人是最早将现代 GIS(地理信息系统)数据应用于应急响应服务的人之一。此后,他们不断创新,为公共安全机构带来更多、更好的位置数据,包括广泛使用 API。

GeoComm 是一家高度专业化的公司,在最高风险的情况下处理关键任务数据。让他们的精力集中在核心竞争力上至关重要。他们为公共部门机构提供服务,努力保持低成本和精简运营,同时仍保持最高质量的产品。他们对开源工具的质量感到满意,例如用于基于 Kubernetes 的应用程序的 API 网关和托管 API 文档的 Stoplight Elements。这些工具让他们能够管理成本并将精力投入到真正重要的事情上,这样他们就可以提供更好的公共安全工具。

API 帮助公司转型为移动解决方案提供商

普利司通是领先的轮胎制造商,自 1931 年开始营业。普利司通集团在 150 多个国家和地区拥有约 130 家制造工厂和研发机构,提供优质轮胎、解决方案、多元化产品和探索性业务。

普利司通的解决方案业务专注于在使用普利司通轮胎时为客户增加价值。随着越来越多的车辆在物联网和 ICT 相关技术的帮助下实现互联,生成有关车辆及其组件的数据,以帮助管理和减少停机时间。作为这一趋势的一部分,轮胎也变得越来越互联,有关轮胎相关性能的数据正在被收集。普利司通的目标是结合其在轮胎设计和开发、扩展服务范围和数字平台/应用程序方面的领先专业知识,成为提取可行见解的最佳人选。

作为移动解决方案提供商,他们利用 API的强大功能与各种合作伙伴系统集成。为此,API 是其业务战略的前沿和中心,这需要对整个端到端 API 计划进行彻底改造。这一广泛举措的一部分促使他们采用左移设计方法,在设计过程的早期采用更加以客户为中心的 API 开发方法,让内部和外部利益相关者参与进来。这种方法的好处包括提高开发速度、降低 API 返工成本以及共同价值创造。他们对 API 网关的选择很简单 – 他们选择了云提供商的本机解决方案,因为它是最直观和一致的,并且可以轻松简化跨团队的流程。

打开正确的门并提供一张好的地图。

通用设计的那些原则——这些可帮助 API 团队解决以下每个要素:

  1. 网关有助于减少 API访问的技术障碍,有助于确保您的文档是最新的且易于访问,从而改善公平使用。
  2. 网关和协作设计工具可帮助各种利益相关者通过单个可预测的界面与您的 API 产品互动,支持灵活使用。
  3. 明确设计用于简化复杂系统并提高一致性的 API 工具将允许用户直观地在功能和产品之间移动。
  4. 网关工具旨在使您的 API 更加人性化,并重视将关键信息放在最需要的地方 – 一般来说,它们将不断改进可访问性,以便您可以让所有人都能感知信息您的 API 用户。
  5. 虽然构建具有容错能力的系统很重要,但使用 API 网关是为用户建立明确的首选路径并首先减少出现错误的可能性的好方法。它可以帮助您有效地规划路径,而出色的文档可以帮助用户在不确定如何继续时进行导航。
  6. 正如上面的两个示例所示,选择正确的工具有助于减轻 API 团队的认知负担并消除压力源 – 一旦就位,您的 API 工具应该是轻松的工作,这样您就可以专注于使用 API 创造价值。
  7. 这有点牵强,但即使是视觉组织方面的微小改进,无论是通过网关、文档还是 API 目录,都可以通过为用户提供查看 API程序不同部分的空间来提高生产力。清楚地。

我们建议考虑您的 API 工具,特别是您的设计工具、网关和文档解决方案,为您的 API 利益相关者建立一条顺畅的道路。用户体验设计师使用“首选路径”的概念来讨论潜在用户如何浏览网站或应用程序。当用户遵循首选路径时,他们会减少挫败感,并更好地了解产品的功能及其提供的可能性。

开发者体验也是如此!您并不确切知道开发人员将使用您的 API 做什么,但您知道在探索之路上有更好和更差的方法。

原文链接:Pave a Smooth Path for API Stakeholders with Gateways

#你可能也喜欢这些API文章!