為了能夠讓開發人員快速高效的學習和使用雲產品 OpenAPI ,阿里雲為使用者提供 OpenAPI 門戶網站。本文將為您詳細介紹 OpenAPI 門戶的功能。
OpenAPI 門戶
OpenAPI 門戶,英文名稱 OpenAPI Portal 或 OpenAPI Explorer。它是一款集 OpenAPI 智能搜尋、文檔、線上調試、SDK 擷取、CodeSample、調用出錯診斷、調用統計為一體的產品。您可以在 OpenAPI 門戶中調用阿里雲各雲產品開放的 OpenAPI ,查看 OpenAPI 請求和返回結果。此外, OpenAPI 門戶會自動產生相應 OpenAPI 的 SDK 調用樣本,協助您使用阿里雲 OpenAPI 。
功能說明
網站地址:https://next.api.alibabacloud.com
OpenAPI 門戶要求開發人員必須登入,通過使用者登入身份,系統會自動擷取可用的 AK 資訊,調用 OpenAPI ,無需使用者在調試介面傳入 AK 資料,提升 OpenAPI 調試的便捷性。
如果您使用阿里雲帳號(主帳號)登入系統,系統預設會擷取阿里雲帳號(主帳號)的AK資料,主帳號擁有產品的全部許可權,在進行OpenAPI調試時要格外小心,避免誤操作。
OpenAPI 門戶提供以下功能:
OpenAPI 檢索
彙集阿里雲多個產品的 OpenAPI ,可以在此集中檢索,快速找到您所需要的 API。
OpenAPI 調用
無需編寫代碼,在調用頁面中填寫請求參數,便可調用 OpenAPI 。
查看 OpenAPI 請求
根據您填寫的請求參數自動產生 OpenAPI 請求,並列印到網頁上,讓您直觀地查看到真實發送的 OpenAPI 請求。
結構化輸出返回結果
根據 OpenAPI 請求,返回真實的 OpenAPI 調用結果,結構化輸出。
產生 SDK 調用樣本
根據輸入的 OpenAPI 請求參數,自動產生多種語言的 SDK 調用樣本。
命令列調用
提供網頁版命令列工具,類比 Linux 操作體驗使用命令列調用 OpenAPI 。
使用情境
查看 OpenAPI 文檔
OpenAPI 門戶提供完整的 OpenAPI 文檔,包含介面說明、流控資訊、授權資訊、請求參數、返回資料、返回說明、返回樣本、錯誤碼、變更歷史等。您可通過閱讀 OpenAPI 文檔判斷它是否能夠滿足您的業務情境。
OpenAPI 調試
在基於阿里雲 OpenAPI 進行二次開發前,您可以預先驗證 OpenAPI 請求方式,入參和查看 OpenAPI 的返回結果。 OpenAPI 門戶提供了網頁和命令列兩種方式調用 OpenAPI ,讓您直觀地查看 OpenAPI 的調用結果。而且,當調用出錯時, OpenAPI 門戶會提示您如何解決,協助您快速瞭解 OpenAPI 功能及使用方法。
命令列調試
如果您打算編寫 Shell 指令碼來管理雲資源,但又不清楚該如何編寫操作雲資源的命令,可訪問 OpenAPI 門戶的API 調試介面,選擇 CLI 樣本,查看命令列。
整合阿里雲SDK
OpenAPI 門戶支援使用者通過整合阿里雲SDK來完成API調用。在產品首頁的 SDK 目錄中,列舉了雲產品 SDK 支援的語言。您可根據實際業務需要的語言和整合方式將 SDK 引入到您的專案中。並且
在您使用 SDK 進行開發時,往往需要一些程式碼範例來輔助您進行開發。在 OpenAPI 門戶中輸入 API 請求參數的同時,會幫您產生 Java、PHP、Python、Node.js 等範例程式碼,以引導您進行開發。並且在對應語言的 SDK 頁面,有 SDK 整合範例程式碼,協助您快速完成整合工作。
整合CDK
阿里雲Resource Orchestration Service(ROS)支援通過 CDK 定義資源,完成資源建立和配置,實現自動化部署及營運。 OpenAPI 門戶提供 CDK 的整合調試、產生程式碼範例等。