阿里云API網(wǎng)關(guān)服務(wù)-使用手冊-D

《阿里云API網(wǎng)關(guān)服務(wù)-使用手冊-D》由會員上傳分享，免費在線閱讀，更多相關(guān)內(nèi)容在行業(yè)資料-天天文庫。

1、API網(wǎng)關(guān)使用手冊（開放API）API網(wǎng)關(guān)/使用手冊（開放API）使用手冊（開放API）提供APIAPI網(wǎng)關(guān)（APIGateway），提供高性能、高可用的API托管服務(wù)，幫助您對外開放您部署在ECS、容器服務(wù)等阿里云產(chǎn)品上的應(yīng)用，為您提供完整的API發(fā)布、管理、維護生命周期管理。您只需簡單操作，即可快速、低成本、低風險的開放數(shù)據(jù)或服務(wù)。在API網(wǎng)關(guān)您可以：1.管理您的API您可以對API的整個生命周期進行管理，包括API的創(chuàng)建、測試、發(fā)布、下線、版本切換等操作。2.便捷轉(zhuǎn)換數(shù)據(jù)支持自定義映射規(guī)則，您可以配置映射將調(diào)用請求轉(zhuǎn)換成后端需要的格式。3.預(yù)設(shè)請求校驗?zāi)梢灶A(yù)

2、先設(shè)置參數(shù)類型、參數(shù)值（范圍、枚舉、正則、JsonSchema）校驗，由網(wǎng)關(guān)幫助您過濾掉非法請求，減少您的后端對非法請求的處理成本。4.靈活控制流量您可以對API、用戶、應(yīng)用設(shè)置按分鐘、小時、天的調(diào)用量控制。您還可以設(shè)置特例用戶或者應(yīng)用，對某個用戶或應(yīng)用單獨配置流量控制。輕松安全防護支持Appkey認證，HMAC（SHA-1,SHA-256）算法簽名。支持SSL/TSL加密，并借助阿里云盾防病毒、防攻擊。全面監(jiān)控與報警為您提供可視化API實時監(jiān)控，包括：調(diào)用量、調(diào)用方式、響應(yīng)時間、錯誤率，并支持歷史情況查詢，以便統(tǒng)籌分析。您還可以配置預(yù)警方式（短信、Email）,訂

3、閱預(yù)警信息，以便實時掌握API運行情況。7.降低開放成本為您自動生成API文檔和SDK（服務(wù)端、移動端），降低API開放成本。創(chuàng)建API創(chuàng)建API是定義API請求的過程。您需要在創(chuàng)建中定義API的請求調(diào)用格式、定義網(wǎng)關(guān)拋向后端服務(wù)的請求格式、定義返回結(jié)果格式、定義參數(shù)校驗規(guī)則等等。定義請求的基本信息API基本信息包括API分組、API名稱、描述、API類型。9API網(wǎng)關(guān)/使用手冊（開放API）1.API創(chuàng)建時需要選擇分組。分組是API的管理單元，創(chuàng)建API之前您需要先創(chuàng)建分組。（API分組的詳細說明見下文的"分組及域名"）分組攜帶Region屬性且每個分組有不同的域

4、名，同一個分組下的API的Region和域名都是相同的。分組一旦選定不可更改。2.API名稱應(yīng)為該分組下唯一，一旦選定不可更改。3.API類型分為公開和私有兩種。在公測階段，兩種類型無實際差別。定義請求的后端服務(wù)信息API后端服務(wù)信息包括后端服務(wù)類型、后端服務(wù)地址和后端超時時間。1.后端服務(wù)類型。目前僅支持HTTP，其他類型如Sigma、Mock后續(xù)會陸續(xù)支撐。2.后端服務(wù)地址。是指API網(wǎng)關(guān)調(diào)用底層服務(wù)時的完整地址，包含域名/IP+Path?？梢园瑒討B(tài)參數(shù)，比如動態(tài)參數(shù)為username，寫作[username]，這些動態(tài)參數(shù)只能從調(diào)用者傳入的Path中獲取，所

5、以您需要在下一步配置Path時選擇性的做映射，并且定義最終Path時不要遺漏這些動態(tài)參數(shù)。后端服務(wù)地址中不能包含Query參數(shù)。3.后端超時時間。指API請求到達網(wǎng)關(guān)后，由網(wǎng)關(guān)去調(diào)API后端服務(wù)的響應(yīng)時間，由網(wǎng)關(guān)請求后端開始到網(wǎng)關(guān)收到后端返回結(jié)果的時間。該值不能超過30秒。定義API請求格式API請求格式定義包括協(xié)議及方法定義、Path的定義、入?yún)⒍x、系統(tǒng)參數(shù)定義、參數(shù)映射、參數(shù)校驗定義。1.協(xié)議及方法定義。API調(diào)用支持HTTP/HTTPS協(xié)議。Method方法可選擇PUT、GET、POST、DELETE、HEAD、MULITIPART。2.Path定義。這個P

6、ath是指服務(wù)對外開放后，調(diào)用者調(diào)用API網(wǎng)關(guān)時的路徑，可以與后端服務(wù)地址中的Path不同，網(wǎng)關(guān)會保存對應(yīng)關(guān)系完成尋址。如果您輸入的后端服務(wù)地址中存在動態(tài)參數(shù)，這些動態(tài)參數(shù)需要通過Path獲取，您可以在定義Path的時候進行參數(shù)映射，注意最終的Path地址不要遺漏這些動態(tài)參數(shù)。只要保證該Path中的動態(tài)參數(shù)與后端服務(wù)地址中的動態(tài)參數(shù)相對應(yīng)即可，其他部分可以與后端服務(wù)地址中的Path不同。3.入?yún)⒍x。您在這部分定義用戶調(diào)用API時需要傳入的參數(shù)，分別對請求的Header、Query和Body進行入?yún)⒍x。您需要定義用戶請求傳入的參數(shù)名稱，參數(shù)類型如String、Nu

7、mber、Boolean、Json等。選擇參數(shù)是否必填，并給出示例值、默認值及描述。Body參數(shù)可以選擇透傳。4.參數(shù)校驗定義。在定義入?yún)r，您還可以點擊"更多"來為該參數(shù)設(shè)置校驗，如枚舉值、String的長度校驗、Number的最大最小值校驗等等。網(wǎng)關(guān)會預(yù)先對非法請求進行攔截，減輕您后端服務(wù)的負擔。5.參數(shù)映射。如果您想要用戶輸入的參數(shù)名稱與您后端實際的參數(shù)名稱不符，或者您后端實際參數(shù)名稱不方便直接暴露給用戶，那么您只需要在定義參數(shù)時選擇需要參數(shù)映射，既可以為每個參數(shù)配置起后端參數(shù)映射。系統(tǒng)參數(shù)定義。系統(tǒng)參數(shù)對于API的調(diào)用者是不可見的。系統(tǒng)參數(shù)有兩種，一種是