API 閘道相容模式
API Designer 提供 API 閘道相容模式，協助您將定義匯入至 AWS API Gateway 和 Azure API Management。
在以閘道相容模式匯出 API 時，API Designer 可能會修改您的定義，以便成功將其匯入至選取的閘道。
在某些情況下，不會進行任何修改，但會顯示一則訊息，通知您在匯出的定義中可能會遇到的相容性問題。
匯出 AWS API Gateway 的 OAS 3.0 定義
下表說明 API Designer 在匯出定義時如何處理 AWS API Gateway 不支援的功能，以及在匯入定義時 AWS API Gateway 中會發生什麼情況。
| 不支援的 OpenAPI 功能 | 匯出時的 API Designer 行為 | 匯入時的 AWS API Gateway 行為 |
|---|---|---|
| 不支援 example 屬性。 | 保留該屬性。 | 從結構描述中移除該屬性。 |
| 不支援 readOnly 屬性。 | 保留該屬性。 | 從結構描述中移除該屬性。 |
| 不支援 additionalProperties 屬性。 | 保留該屬性並顯示資訊訊息。 | 顯示警告訊息，但可以忽略，且定義可成功匯入。 |
安全性定義類型：
|
保留安全性配置並顯示資訊訊息。 | 顯示警告訊息，但可以忽略，且定義可成功匯入。 |
| 不支援回應中的基本資料類型。 | 基本類型會包裝到元件結構描述中，並顯示警告訊息。 | 匯入成功。 |
| 不支援媒體類型範圍。 | 保留要求或回應並顯示資訊訊息。 | 匯入失敗並顯示警告訊息。 |
| 不支援預設回應。 | 保留回應並顯示資訊訊息。 | 匯入失敗並顯示警告訊息。 |
| 不支援範圍回應。 | 保留回應並顯示資訊訊息。 | 匯入失敗並顯示警告訊息。 |
| 路徑變數、查詢參數和標頭必須具有唯一的名稱。 | 保留參數並顯示錯誤訊息。 | 匯入失敗。 |
匯出 Azure API Management 的 OAS/Swagger 2.0 定義
下表說明 API Designer 在匯出定義時如何處理 Azure API Management 不支援的功能，以及在匯入定義時 Azure API Management 中會發生什麼情況。
| 不支援的 OpenAPI 功能 | 匯出時的 API Designer 行為 | 匯入時的 Azure API Management 行為 |
|---|---|---|
| 跨路徑和查詢的必要參數必須具有唯一的名稱。 | 顯示錯誤訊息。 | 匯入失敗。 |