1 定義 API

在API網關控制臺中API列表頁面，單擊創建API，即進入API的創建和定義流程。

1.1 定義請求的基本信息

1.2 定義API請求

定義用戶如何請求API，包括協議、請求Path、HTTP Method、入參請求模式和入參定義。

配置入參定義：定義您API的請求入參，即配置用戶需要在什么位置傳入什么參數。可選位置有Head、Query、Body、Path（Parameter Path），尤其當您在Path中配置了動態參數，那么在入參配置時需要對動態參數做配置說明。支持的參數類型有String、Integer、Boolean。

• 需要注意所有參數的名稱會校驗是否唯一。

• 您可以使用左側的快捷鍵快速調整參數順序。

• 您可以使用操作圖標下的移除選項，移除不需要的參數。

設置參數校驗規則：您可以單擊操作圖標中的編輯更多配置校驗規則。如String的長度，Number的枚舉等等。網關會參照校驗規則對請求做初步校驗，如果入參不合法，則不會到達您的后端服務，大大的降低了后端服務的壓力。

1.3 定義后端服務信息

這部分主要是定義一些參數的前后端映射，具體描述的是您后端真實服務的API配置。用戶請求到達網關后，網關會根據您的后端配置映射為對應實際后端服務的請求形式，去請求您的后端。包括后端服務地址、后端Path、后端超時時間、參數映射、常量參數、系統參數。

后端基礎定義

配置后端服務參數： 網關支持參數在前端、后端的全映射，包括名稱映射和位置映射。位置映射包括Path、Header、Query、Body的混排映射。也就是說，您可以將您的后端服務通過映射完成包裝成更規范、更專業的API形態。這部分就是在聲明前后端API映射關系的。

配置常量參數：您可以配置常量參數。您配置的常量參數對您的用戶不可見，但是API網關會在中轉請求時，將這些參數加入到請求中的指定位置，再傳遞至后端服務，實現您的后端的一些業務需求。比如您需要網關每次請求您后端時都帶有參數abc，您可以直接將abc配置為常量參數。請求達到網關后，網關會自動在指定位置加上該參數再去請求您的后端。

配置系統參數：指API網關的系統參數。默認系統參數不會傳遞給您，但是如果您需要獲取系統參數，您可以在API里配置接收位置和名稱。具體內容如下表：

可以在分組詳情中設置透傳HOST頭（域名頭），開啟后API網關會將請求域名透傳至后端，若沒有開啟，后端收到的是用戶在API網關填寫的后端HOST。示例如下：

示例中API分組綁定的請求HOST為xuemeng.XXXX.com，API后端HOST為apigatewayXXXXXXalicloudapi.com:8080，配置前后如下

透傳HOST頭（域名頭）開啟時：

Host: xuemeng.XXXX.com

透傳HOST頭（域名頭）未開啟時：

Host: apigatewayXXXXXXalicloudapi.com:8080

1.4 定義返回結果

錄入返回ContentType、返回結果示例、失敗返回結果示例和錯誤碼定義。

2 API 調試

API定義錄入完成后，您可以在API調試頁面調試API，以確定API的可用性。

API創建、定義完成后，頁面自動跳轉到API列表頁。您可以通過此頁面按鈕，測試創建的API是否可用，請求鏈路是否正確。

1. 單擊API名稱或管理按鈕，進入API定義頁面。

2. 單擊左側導航欄中調試API。

3. 輸入請求參數，單擊發送請求。

返回結果將顯示在右側頁面。

如果調試返回成功結果，則說明該API可以使用。

如果返回代碼為4XX或5XX，則表示存在錯誤。請參見如何獲取錯誤信息和錯誤代碼表。

3 后續步驟

完成以上定義后和初步調試后，您就完成了API的創建。您可以發布API到測試、預發、線上環境，繼續調試或供用戶使用。還可以為API綁定客戶端簽名說明文檔等安全配置。