本文講述該如何創建API。
1 如何創建API
創建API的方式有三種:通過控制臺創建API、通過管控API創建API、通過導入Swagger創建API
通過控制臺創建API
登錄阿里云API網關控制臺,左上角選擇地域,然后在分組中創建API。具體步驟可參考創建 API
使用管控API創建API
可以通過管控API創建API,具體操作可參考CreateApi - 創建 API
通過導入Swagger創建API
Swagger是一種用于描述API定義的規范,被廣泛應用于定義和描述后端應用服務的API?,F在,API網關支持導入Swagger 2.0的文件來創建API。目前有兩種方式:
- 通過管控API導入Swagger創建,具體參考ImportSwagger - 通過 Swagger 創建 API;
- 在控制臺上進行操作,具體可參考:導入API網關的擴展Swagger定義
2 API網關實例選擇及分組
2.1 實例選擇
API網關實例指用于接入并處理您的API的一組資源,包含公網IP、內網IP、公網出口、負載均衡,API網關支持共享實例、Serverless 實例和專享實例兩種,適用于不同的使用場景:
專享實例適用場景:提供高性能和高SLA保證,適合生產環境使用。
共享實例適用場景:開發測試、評估和小規模的生產環境使用。
Serverless實例適用場景:測試及中小規模的生產環境使用。
關于三種實例的具體差異可以參見 實例類型與選擇指南。
2.2 分組
API 分組是 API 的管理單元。創建 API 之前,需要先創建分組,分組創建時,系統會為分組分配一個二級域名。該二級域名僅供測試使用,客戶端直接調用時會有每天1000次訪問限制(海外Region及中國香港限制100次/天)。 建議為分組綁定一個在阿里云系統備案成功的獨立域名,進而可以通過域名調用API。
關于分組域名綁定的詳細信息可參考使用自定義域名調用API
3 創建API的步驟
3.1 定義請求的基本信息
API基本信息包括API分組、API名稱、安全認證方式、API選項和描述。
3.2 定義API請求
定義用戶如何請求API,包括請求類型、協議、自定義域名、請求Path、HTTP Method、入參請求模式、和入參定義。
API網關支持的請求協議包括HTTP、HTTPS。
3.3 定義后端服務信息
定義一些參數的前后端映射,即API后端服務的配置,包括后端服務類型、后端服務地址、后端Path、HTTP Method、后端超時時間、參數映射、常量參數、系統參數。用戶請求到達API網關后,API網關會根據您的后端配置,映射為對應的后端服務的請求形式,請求后端服務。
API網關支持的后端服務包括HTTP(S)、函數計算、VPC和Mock。
HTTP(S),通過API網關訪問HTTP協議的后端服務
函數計算,函數計算
Mock,Mock
3.4 定義返回結果
錄入返回ContentType、返回結果示例、失敗返回結果示例、和錯誤碼定義。
4 環境管理
當前每個API分組支持設置三個環境:測試(TEST)、預發(PRE)和線上(RELEASE)。目的是能夠滿足不同研發場景下的API 調用需求,如API測試環境,后端服務對應到測試環境資源,從而可以保證在同一套API配置的情況下,供測試人員進行測試使用。
更多詳情可參考環境管理