查看 Application Integration 支援的連接器。

查看整合項目的 OpenAPI 規範

應用程式整合功能可動態產生及查看已發布的整合項目 OpenAPI 規格，這些整合項目已設定一或多個 API 觸發事件。存取整合作業的 OpenAPI 規範可讓您：

• 全面瞭解整合作業的 API 端點、方法和資料結構。
• 提供整合項目 API 的詳細集中檢視畫面，讓開發和疑難排解作業更有效率。
• 公開整合 API，並與對話式代理服務無縫整合，請參閱「使用應用程式整合功能建構對話式代理服務」。

什麼是 OpenAPI 規範？

OpenAPI 規格 (OAS) 是一種不受語言限制的標準格式，可用來說明 RESTful API。OpenAPI 規格通常以 YAML 或 JSON 格式編寫，可正式說明 API 元素，例如基本網址、路徑和動詞、標頭、查詢參數、內容類型、要求和回應模型等。如要進一步瞭解 OpenAPI 規範，請參閱 OpenAPI 規範。

產生及查看 OpenAPI 規範

您可以透過 Google Cloud 控制台的整合編輯器或 API 呼叫，為整合項目動態產生及查看 OpenAPI 規格。

事前準備

• 確認整合已設定一或多個 API 觸發事件。如要瞭解如何設定 API 觸發條件，請參閱「API 觸發條件」。
• 發布整合項目。如要瞭解如何發布整合項目，請參閱「測試及發布整合項目」。

查看 OpenAPI 規範

如要查看整合作業的 OpenAPI 規格，請選取下列任一選項：

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -d '{
    "apiTriggerResources": [{
    "integrationResource": "INTEGRATION_NAME",
    "triggerId": ["api_trigger/TRIGGER_NAME", "api_trigger/TRIGGER_NAME_2", "api_trigger/TRIGGER_NAME_n"]
    },
    {
    "integrationResource": "INTEGRATION_NAME",
      "triggerId": ["api_trigger/TRIGGER_NAME"]
    }],
    "fileFormat": "DOC_TYPE"
    }' \
    "https://LOCATION-integrations.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION:generateOpenApiSpec"
          

瞭解 OpenAPI 規範

應用程式整合會根據 OpenAPI 規範 3.0 標準，為已發布的整合項目產生 OpenAPI 規格。下表說明在應用程式整合中產生的 OpenAPI 規格元素：

注意事項

查看整合作業的 OpenAPI 規格時，請考量下列事項：

• OpenAPI 規範只會針對已發布的整合項目產生。
• OpenAPI 規格只會針對使用一或多個 API 觸發事件設定的整合項目產生。
• OpenAPI 規範只會針對位於同一區域的整合項目產生。
• 系統預設會以 YAML 格式產生 OpenAPI 規格。如要以 JSON 格式產生及查看 OpenAPI 規格，請在 API 呼叫中將 fileFormat 參數設為 JSON。
• 應用程式整合功能目前僅支援以下有限的 JSON 結構定義關鍵字：
  • type
  • items
  • properties
  • description
  • required
  • array
  • object
  • oneOf
  • allOf
  • anyOf
  • not
  • null
  • enum
  • additionalProperties
  • default
• 使用 Swagger Editor 驗證 OpenAPI 規格時，您可能會遇到與 API 路徑相關的語義錯誤，如下圖所示：

  

  您可以放心忽略這些錯誤。OpenAPI 規範仍有效。

後續步驟

• 運用 Application Integration 建構對話型代理。
• 瞭解 API 觸發條件。
• 瞭解如何測試及發布整合項目。