OpenAPI 2.0 功能限制

以下各節說明 API Gateway 上的 OpenAPI 2.0 功能相關限制。

忽略範圍

雖然 API Gateway 接受在安全性配置物件中定義範圍的 OpenAPI 文件，但不會檢查或強制執行這些範圍。

多項安全性要求

• API 金鑰規定：如果其中一個配置是 API 金鑰，API Gateway 就不支援其他 (邏輯 OR) 安全性要求。不過，系統支援連詞 (邏輯 AND)，因此您可以同時要求 API 金鑰和 OAuth2 權杖。
• OAuth2 要求：不同的 OAuth2 安全性配置支援其他的安全性要求 (邏輯 OR)。
• 不支援不同 OAuth2 安全性配置的連詞 (邏輯 AND) 安全性要求。
• 選用安全性：空白安全性需求 (- {}) 可用於將 API 金鑰的安全性設為選用，但 OAuth 不支援這項功能。

安全性定義驗證

如果 OpenAPI 3.x 規格使用安全需求，但 securityDefinitions 區段中沒有對應的定義，API Gateway 就會拒絕該規格。

網址路徑範本

API Gateway 僅支援代表整個路徑區段的網址路徑範本參數 (例如 /items/{itemId})。系統不支援對應部分區段的參數 (例如 /items/prefix_{id}_suffix)，且會拒絕這類參數。

參數、結構定義和類型

API Gateway 接受含有各種參數和類型定義的 OpenAPI 文件 (例如 required 參數、陣列格式)，但不會強制執行。無論這些定義為何，傳入要求都會轉送至您的 API。

外部類型參考資料

API Gateway 不支援所提供 OpenAPI 文件以外類型的參考資料。舉例來說，指向外部網址的 $ref 不會獲准。

主機位址中的自訂通訊埠

API Gateway 不允許在 OpenAPI 文件的 host 欄位中使用自訂通訊埠。

YAML 別名限制

提交至 API Gateway 的 OpenAPI 文件最多可有 200 個 YAML 別名節點。