使用轉換原則遮罩 URL
組織可能需要在短暫通知時調整 API 所發佈的資訊。 例如,為了遵守法律的變更或應對新的安全性威脅。
人口普查 API 範例會公開呼叫 API 所用的 URL 相關詳細資料。 這項資訊可讓惡意使用者藉由略過 API 管理閘道並公開較不安全的端點來嘗試存取人口普查資料。 身為首席開發人員,您想要在 API 的回應本文內遮罩這些 URL。
在這裡,您會了解如何使用 API 管理原則來操作 API 回應標頭和本文的內容。
為何要轉換回應?
API 呼叫的回應本文包含了所要求資料。 例如,在 Census API 中,回應本文會包含受訪者的 JSON 資料。 您也可以查看本文如何包含用來檢視個別人員的 URL 連結:
這些連結是以 Census API 端點為基礎,且需要遮罩以改為顯示 API 管理 URL。
若要達成這項設定,請建立轉換原則。
注意
最佳做法是使用 API 管理中的其中一個可用機制來保護後端 API。 例如,將它設定為需要用戶端憑證,然後設定API 管理來提供該憑證。 在此設定中,因為沒有人具有經後端辨識的憑證,所以任何人都無法直接呼叫後端 API 並規避您的 API 管理閘道。
轉換原則
轉換原則會修改 API 呼叫的內容。 某些轉換原則適用於標頭,其他轉換原則則適用於本文。 可用的轉換如下:
轉換 | 描述 |
---|---|
將 JSON 轉換成 XML | 將要求或回應本文從 JSON 轉換成 XML。 |
將 XML 轉換成 JSON | 將要求或回應本文從 XML 轉換成 JSON。 |
在本文中尋找並取代字串 | 尋找要求或回應子字串,並取代為不同的子字串。 |
遮罩內容中的 URL | 重寫回應本文中的連結,使其透過閘道指向同等的連結。 |
設定後端服務 | 變更傳入要求的後端服務。 |
設定本文 | 設定要求或回應的訊息本文。 |
設定 HTTP 標頭 | 指派值給現有的回應或要求標頭,或是新增新的回應或要求標頭。 |
設定查詢字串參數 | 新增、取代要求查詢字串參數的值,或刪除要求查詢字串參數。 |
重寫 URL | 將要求 URL 從公用格式轉換成 Web 服務所需的格式。 |
使用 XSLT 轉換 XML | 將 XSL 轉換套用至要求或回應本文中的 XML。 |
在下列線習中,您將使用 遮罩內容中的 URL 轉換來改變連結。