自訂連接器

本頁面提供 Integration Connectors 中自訂連接器功能的總覽,並假設您已熟悉下列概念:

透過自訂連接器功能,您可以使用不屬於 Integration Connectors 所提供標準連接器的連接器。舉例來說,您可能擁有內部的人力資源管理系統 (HRMS),並採用專屬的連線通訊協定,希望透過連接器向 Application Integration 公開。自訂連接器功能適用於下列情境:

  • 如果想連線的資料來源或服務沒有內建連接器,您可以使用 Integration Connectors。
  • Integration Connectors 提供內建連接器,但無法滿足您的需求。

整合連接器如何支援自訂連接器?

整合連接器支援透過 Open API 規格 (3.0.0 版和所有次要版本) 建立自訂連接器。您可以將後端公開為公開端點,然後使用端點的 Open API 規格建立新連接器,連線至端點 (後端)。

端點的 Open API 規格會定義整合連接器與端點之間的合約。Integration Connectors 會使用 API 規格產生連接器的動作和實體。API 規格可以是 JSON 或 YAML。以下是後端服務的 Open API 規格範例摘錄:

{
  "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"
        ],
        .....
        .....
      }
    }
  },
  "components": {
    "securitySchemes": {
      "api_key":{
        "type":"apiKey",
        "name":"api_key",
        "in":"header"
      }
    }
  }
}

如要查看完整的範例規格,請參閱寵物商店存放區範例。 假設您使用這個範例規格建立自訂連接器,Integration Connectors 會為 path 中的每個元素產生個別動作。舉例來說,自訂連接器會將 uploadImagefindByStatus 列為支援的動作。

後端連線情境

Integration Connectors 支援下列後端連線情境的自訂連線器:

  • 直接連線至後端
  • 間接後端連線

情境 - 直接連線至後端

在這個情境中,Integration Connectors 執行階段會直接建立與 Open API 相容後端的連線。下圖顯示這個情境中的連接器連線:

直接後端連線

情境 - 間接後端連線

在此情境中,Integration Connectors 執行階段會透過符合 Open API 規範的中介 (門面) 服務,建立與後端的連線。中介服務會連線至後端。下圖說明這個情境中的連接器連線:

間接後端連線

自訂連接器版本

您可以使用版本控管功能建立多個自訂連接器版本。每個版本可以有不同的 OpenAPI 規格、驗證方法和後端變數。可彈性建立各種設定的連接器。

建立新連結器時,系統會自動為您建立第一個連結器版本,並在自訂連結器詳細資料頁面的「版本」分頁中顯示版本詳細資料。如要瞭解如何建立連接器的新版本,請參閱「管理自訂連接器版本」。

後續步驟

瞭解如何建立自訂連接器