自定义连接器

本页面简要介绍了集成连接器中的自定义连接器功能,假定您熟悉以下概念:

借助自定义连接器功能,您可以使用不属于集成连接器提供的标准连接器的连接器。例如,您可能拥有一个采用专有连接协议的内部人力资源管理系统 (HRMS),并且希望通过连接器将其公开给应用集成。自定义连接器功能在以下情况下非常有用:

  • 您要关联的数据源或服务没有可用的集成连接器内置连接器。
  • 集成连接器中提供了内置连接器,但它们不符合您的要求。

集成连接器如何支持自定义连接器?

集成连接器通过 Open API 规范(版本 3.0.0 及其所有次要版本)支持自定义连接器。您可以将后端公开为公共端点,然后使用端点的 Open API 规范创建一个新的连接器来连接到端点(后端)。

端点的 OpenAPI 规范定义了集成连接器与端点之间的协定。 集成连接器使用 API 规范生成连接器的操作和实体。 API 规范可以是 JSON 或 YAML。以下是后端服务 OpenAPI 规范示例的摘录:

{
"openapi":"3.0.2",
"info":{
	"title":"Swagger Petstore - OpenAPI 3.0",
	"description":"This is a sample Pet Store Server based on the OpenAPI 3.0 specification.
  You can find out more about\nSwagger at [
	http://swagger.io](http://swagger.io). In the third iteration of the pet store,
	we've switched to the design first approach! You can now help us improve the API whether
  it's by making changes to the definition itself or to the code.\nThat way,
	with time, we can improve the API in general, and expose some of the new
  features in OAS3.\n\nSome useful links:\n-
  [
	   The Pet Store repository
	]
.....
.....
"paths":{
"/pet/{petId}/uploadImage":{
  "post":{
    "tags":[  
},
.....
.....  
"/pet/findByStatus":{
  "get":{
    "tags":[
      "pet"
    ],
.....
.....  
},
"api_key":{
  "type":"apiKey",
  "name":"api_key",
  "in":"header"
}
}
}
}

如需查看完整示例规范,请参阅宠物商店示例代码库。 假设您使用此示例规范创建自定义连接器,集成连接器将为 path 中的每个元素生成单独的操作。例如,uploadImagefindByStatus 会列为自定义连接器支持的操作。

后端连接场景

集成连接器支持以下后端连接场景的自定义连接器:

  • 直接后端连接
  • 间接后端连接

场景 - 直接后端连接

在这种情况下,集成连接器运行时会直接与符合 Open API 标准的后端建立连接。下图显示了此场景中的连接器连接情况:

直接后端连接

场景 - 间接后端连接

在此场景中,集成连接器运行时会通过符合 Open API 标准的中介(外观)服务与您的后端建立连接。中介服务会连接到您的后端。下图显示了此场景中的连接器连接情况:

间接后端连接

自定义连接器版本

借助版本控制功能,您可以创建自定义连接器的多个版本。每个版本都可以有不同的 OpenAPI 规范、身份验证方法和后端变量。因此,它为您创建具有各种配置的连接器提供了很大的灵活性。

创建新连接器时,系统会自动为您创建该连接器的第一个版本,并且版本详情会显示在自定义连接器的详情页面版本标签页中。如需了解如何创建新版本的连接器,请参阅管理自定义连接器版本

后续步骤

了解如何创建自定义连接器