全部產品
Search
文件中心

API Gateway:匯入匯出API定義

更新時間:Dec 19, 2024

本篇文檔介紹API Gateway匯入、匯出標準OAS定義,及匯入API Gateway的擴充Swagger定義。協助您高效、安全和自動化地管理和維護API服務。

匯入標準OAS定義

API Gateway支援匯入OAS 2.0和OAS3.0格式的API定義,也支援匯入擴充後的OAS定義,您可以快速將現有系統的API接入網關。使用現有API定義檔案,無需修改就可以在API Gateway中配置並管理這些API。詳細內容包括:

  • 標準OAS2.0格式與API Gateway的對應。

  • 標準OAS3.0格式與API Gateway的對應。

  • 匯入具有API Gateway擴充欄位的OAS格式定義。

匯出標準OAS定義

API Gateway支援匯出標準OAS定義,能將已有API服務的定義從API Gateway中以OAS 2.0或OAS 3.0格式匯出。您可以實現跨帳號,跨地區間甚至跨平台的資料移轉,實現靈活的API管理和部署。詳細內容包括:

  • 匯出標準OAS格式的API定義。

    匯出API定義支援以分組為單位進行API匯出,也支援通過批量勾選API進行匯出。

匯入API Gateway的擴充Swagger定義

API Gateway支援通過匯入Swagger 2.0的檔案來建立API。您可以參考API介面ImportSwagger,或在控制台上進行操作。詳細內容包括:

  • Swagger擴充:Swagger擴充主要是對於swagger原生Operation Object進行擴充,增加認證、參數映射以及後端服務等擴充。

  • 相容性說明:Swagger參數類型與原有API Gateway類型的差異性對照。

  • Swagger樣本:基於API Gateway的Swagger擴充樣本。

  • 特別說明:swagger匯入功能特別說明。