概述
網關響應是指云原生網關在接收到后端服務的響應后,依據用戶配置的響應規則對響應內容進行處理,并將處理后的結果返回給客戶端。用戶可以在API分組中配置網關響應,啟用后,該響應規則會對分組內的所有API生效。
操作步驟
- 登錄微服務引擎MSE云原生網關管理控制臺,選擇資源池。
- 在左側導航欄,選擇云原生網關 > 網關列表,進入對應網關實例的控制臺。
- 在左側導航欄,選擇API托管 > 分組管理,進入要查看的API分組詳情,即可看到網關響應模塊。
新增網關響應
點擊網關響應模塊內的新增按鈕,即可進入網關響應新增彈窗。支持基于模版創建和自定義創建兩種方式。響應編碼支持200-598,每個分組下,同一個響應編碼只能添加一個響應規則。
響應狀態碼
默認情況下,新建的響應規則會保留后端服務返回的原始響應狀態碼。如果需要修改響應狀態碼,可以通過編輯響應規則并填入新的狀態碼。例如,在413的響應規則中填入500,則客戶端接收到的所有413響應都會被替換為500狀態碼。
響應頭
默認情況下,新建的響應規則不會處理響應頭。如果需要修改,可以編輯響應規則并添加對響應頭的處理邏輯。響應頭的處理支持兩種操作方式:設置和刪除。
· 設置 :若響應頭不存在則新增,若已存在則覆蓋。
· 刪除 :用于移除指定的響應頭。
參數值可以是常量、系統參數,或兩者的組合。系統參數可以從預定義列表中選擇,也可以手動輸入,使用**${}** 進行包裹。當匹配到該系統參數時,會自動替換為對應的系統變量值。
響應體
在基于模板創建的響應規則中,默認會將響應內容設置為 JSON 格式,并覆蓋后端服務返回的響應內容。響應體處理規則可進行修改,支持兩種替換方式:全局替換和規則替換。
全局替換
根據配置的響應類型和具體的響應內容,直接覆蓋后端服務返回的完整響應。
規則替換
根據配置的替換規則,對后端服務的響應體進行部分替換。支持使用常量或正則表達式進行匹配,匹配成功后可選擇全量替換或僅替換首次匹配項。替換值可以是常量、系統參數,或兩者的組合。
啟用網關響應
新創建的網關響應規則默認未啟用。要使其生效,請點擊啟用按鈕并保存配置。必須配置響應頭、響應體或兩者,才能啟用該規則。
刪除網關響應
響應規則支持單個刪除和全量刪除。當鼠標懸停在某個響應規則上時,會出現紅色的刪除圖標,點擊即可單個刪除該規則。新增按鈕旁邊的刪除按鈕用于刪除該分組下的所有響應規則。刪除操作不可撤銷,請謹慎操作。