社区编辑申请
注册/登录
API类型和集成规范指南 译文 精选
开发 前端
API的类型和集成的复杂性通常,我们有四种常见的API类型:公共、私有、伙伴和复合。

译者 | 陈峻

策划 | 梁策、孙淑娟

在我们的常见应用中,往往包含着大量服务于各种数据交换的API类型、以及各种常见的API架构与协议。下面,我将从集成的角度和您讨论,在准备将多个服务相互集成时,使用不同类型、架构和协议的API意味着什么?我们可以使用哪些工具,又应该注意什么呢?

API的类型和集成的复杂性通常,我们有四种常见的API类型:公共、私有、伙伴和复合。其中:

1.公共API

公共API有时也被称为开放或外部API。顾名思义,任何人都可以公开的方式,在没有限制、或限制相对较少的情况下使用它。此类API通常是方便第三方与本公司开发的Web应用进行通信的一种方式。一些常见的、为大多数中小企业提供服务的公共API有:PandaDoc、BigCommerce、DocuSign、NetSuite等。

2.如何与公共API集成

与公共API集成相对比较容易。不同的公司都会为您提供必要的API文档,其中描述了各种端点、验证与授权其API的使用和调用方法等。事实上,大多数企业的集成平台都是围绕着公共API的概念来构建的。他们提供的所谓集成连接器,本质上都是各个Web应用的API抽象层。不过,它们在工作机制上的复杂性和范围,则取决于API的设计与文档说明。

总地来说,与公共API集成相关的主要策略有两种:要么像iPaaS那样使用第三方软件;要么自行开发。在您选择后者时,请准备好为数据映射(data mapping,https://www.elastic.io/data-mapping-best-practices/)而设计的相应策略。虽然许多应用程序会使用相同的模式,来命名前端的公共字段,但这些字段在后端可能有着截然不同的标签。适当的策略应该能够保证追溯性、准确性和相对快速的项目实施保障,以及对于一些容易避免的错误予以保护。

值得一提的是,如果您正在为自己的项目寻找一些可公开访问的API,GitHub上就有一个较为详尽的公共API列表(https://github.com/public-apis/public-apis)。它涵括了诸如天气预报等Web应用所需要用到的、完整的API密钥和OAuth授权。

3.私有API

作为公共API的对立面,私有API仅适用于单个公司。企业开发人员经常使用它们来实现Web应用之间在某种程度上的数据交换、提供对企业数据库和其他内部共享服务的访问权限、以及与其他内部API通信、或为公司员工构建内部应用。

事实上,越来越多的公司都认识到了使用自己的API的价值。据此,他们可以节省更多的时间和资源,提高应用的敏捷性和灵活性,并有助于降低整体运营成本。

4.如何与私有API集成

由于私有API通常驻留在具有高度安全性的环境中,因此与它们的集成需要通过非常严格的防火墙或VPN服务,来发起调用(当然首先需要能够允许外部可以访问到)。这意味着,如果您想知道本公司的集成中间件是否确实有用,就应该去检查它是否具有某种安全机制/层,去访问本地系统和Web应用。

同样值得注意的是,那些对于公共API的成功至关重要的某些方面,却可能在私有API中显得无关紧要。例如,由于已被假定为受到了公司现有安全策略的保护,因此安全性机制在私有API并不重要。同时,由于开发人员经常在文档中使用内部或技术性的名称,因此版本控制不一定会被包含在设计中。

无论您准备采用手动编码,还是某个集成式中间件,新加入团队的成员或其他部门,在集成私有API时都会面临一些挑战。因此,如果您正在负责设计私有API的话,我建议您像设计公共API那样,去准备好API的各项最佳实践和检查。

5.伙伴API

伙伴API属于内部API的一个类别,但这些API通常在业务伙伴和B2B客户之间共享,而不是在某个组织内自己使用。此类API的一个常见用例是,在供应链集成或销售点的集成中,连接两个内部业务软件的应用程序。在这种情况下,API往往充当的是经典的EDI(电子数据交换,Electronic data interchange)集成的替代方案。

伙伴API通常具有更加强大的授权、身份验证和安全功能。它们能够允许外部各方去访问某些敏感数据。例如,伙伴CRM或ERP应用的客户数据,或者是医疗机构患者医疗数据等。

6.如何与伙伴API集成

由于伙伴API不是公开可用的,因此您可能无法找到允许即时“连接”的集成方案。如果您打算集成此类伙伴API的话,就需要提供良好的手动编码、或者去寻找支持自助服务、以及自定义连接器的集成中间件的帮助。

有时您可能需要将伙伴API与基于EDI的Web应用相连接,那么您就需要进行诸如从EDIFACT到JSON的各种数据格式的转换。当然,一个良好的企业集成平台,往往能够支持此类功能。此外,您也可以使用各种专用的解析器,例如:用于UN/EDIFACT文档的Javascript流解析器(https://openbase.com/js/edifact/documentation)。

7.复合API

我个人觉得复合API的使用场景最广泛。例如在购物车中创建订单时,就需要对多个端点进行多次API调用,其中包括:创建新的客户、创建新的订单、向该订单添加新的商品、展示分类商品等。一个复合API往往可以在一次性调用中,完成所有这些工作。这无疑加快了多任务处理的能力和效率。例如,下面是Salesforce的复合REST API的属性文件:

{

"compositeRequest" : [{

"method" : "POST",

"url" : "/services/data/v52.0/sobjects/Account",

"referenceId" : "refAccount",

"body" : { "Name" : "Sample Account" }

},{

"method" : "POST",

"url" : "/services/data/v52.0/sobjects/Contact",

"referenceId" : "refContact",

"body" : {

"LastName" : "Sample Contact",

"AccountId" : "@{refAccount.id}"

}

}]

}

在上述文件中,其API在一次性调用中,最多可以有25个所谓的子请求。

复合API的另一个实用场景是,从多个服务中提取信息,以完成微服务架构模式中的单个任务。不过,复合API也不一定需要创建全新的API。在许多情况下,您可以通过在一个序列中包装多个调用或请求,来扩充现有API的设计。

8.如何与复合API集成

在集成方面,复合API与常规公共API并没有太大的区别。事实上,如果您的集成平台方案已经具有被用于REST或SOAP的通用连接器的话,您可以轻松地使用它来连接到复合API处。

9.与不同的API架构和协议集成

下面,让我们简要地讨论一下,在使用具有不同架构和/或协议的API时,该如何定义可接受的数据类型和命令。当然,在大多数时候,您可能会用到REST和SOAP等API。其中,REST是一种架构风格,而SOAP是一种协议。它们之间有着各种相似之处,可以通过HTTP和XML进行通信,因此彼此的集成非常容易。

当然,两者之间也有着显著的差异。例如,

  • 为了在服务器上公开Web应用业务逻辑的特定部分,SOAP会使用服务接口,而REST则使用URI。
  • REST API支持包括:纯文本、XML、JSON和CSV在内的多种数据格式,而SOAP仅支持XML。
  • REST通常也被认为比SOAP更轻量级、而且消耗的资源也更少。

就两者的集成而言,我们需要在这两种API之间进行某种“翻译”。当选择手动集成这些API时,您可以使用Postman等工具来自动执行此类操作。例如,您可以调用一个Web应用程序的SOAP API,并将返回的XML解析为您需要的数据。之后,您可以将该XML转换为诸如JSON格式,并将这些数据推送到另一个Web应用程序的REST API处。可见,当您的公司部署了可以默认处理REST和基于SOAP的Web应用与服务之间的数据转换集成API之后,它将使您的工作变得更加轻松,应用的效率大幅提升。

原文链接:https://dzone.com/articles/a-guide-to-api-types-and-integration-specifics

责任编辑:武晓燕 来源: 51CTO技术栈
相关推荐

2022-04-28 09:00:00

API集成Web

2022-06-27 17:46:53

PythonFlask

2022-05-24 15:22:09

网络安全企业风险

2022-04-02 20:45:04

Hi3516开发板操作系统鸿蒙

2022-06-22 09:56:19

PythonMySQL数据库

2022-06-15 08:21:49

Linux运维工程师

2022-05-24 08:21:16

数据安全API

2022-06-21 09:27:01

PythonFlaskREST API

2022-06-28 22:13:33

Polars数据处理与分析

2022-06-27 15:25:08

架构模型治理

2022-04-18 10:37:01

鸿蒙操作系统开发工具

2022-06-23 09:22:57

Vue技巧前端

2022-05-25 07:11:13

2022-06-08 13:25:51

数据

2022-06-27 17:58:30

Pulsar函数Serverless

2022-06-20 15:31:11

GoogleSOC网络安全

2022-06-30 08:01:33

2022-04-18 17:28:14

React前端

2022-06-24 07:08:24

OHOS自定义服务

2022-06-10 06:55:21

JustAuthSpring

同话题下的热门内容

手把手教你用装饰器扩展 Python 计时器IOC-Golang 的 AOP 原理与应用Vue 里,多级菜单要如何设计才显得专业?分析了 700 万份工作需求,市场需求最高的八种编程语言是这些Vue 2.7 正式发布,代号为 Naruto手把手教你实现一个 Python 计时器2022 年编程语言趋势:Swift、Kotlin 热度持续增长,收入最高的五种语言竟是它们分布式事务(Seata) 四大模式详解

编辑推荐

太厉害了,终于有人能把TCP/IP协议讲的明明白白了!牛人5次面试腾讯不成功的经验HBase原理–所有Region切分的细节都在这里了Javascript如何监听页面刷新和关闭事件如何搭建一个HTTPS服务端
我收藏的内容
点赞
收藏

51CTO技术栈公众号