OpenAPI 門戶

OpenAPI 門戶，英文名稱 OpenAPI Portal 或 OpenAPI Explorer。它是一款集 OpenAPI 智能搜索、文檔、在線調(diào)試、SDK 獲取、CodeSample、調(diào)用出錯診斷、調(diào)用統(tǒng)計為一體的產(chǎn)品。您可以在 OpenAPI 門戶中調(diào)用阿里云各云產(chǎn)品開放的 OpenAPI ，查看 OpenAPI 請求和返回結(jié)果。此外， OpenAPI 門戶會自動生成相應 OpenAPI 的 SDK 調(diào)用示例，幫助您使用阿里云 OpenAPI 。

功能說明

網(wǎng)站地址：https://next.api.aliyun.com。

OpenAPI 門戶要求開發(fā)者必須登錄，通過用戶登錄身份，系統(tǒng)會自動獲取可用的 AK 信息，調(diào)用 OpenAPI ，無需用戶在調(diào)試界面?zhèn)魅?AK 數(shù)據(jù)，提升 OpenAPI 調(diào)試的便捷性。

OpenAPI 門戶提供以下功能：

• OpenAPI 檢索

  匯集阿里云多個產(chǎn)品的 OpenAPI ，可以在此集中檢索，快速找到您所需要的 API。

• OpenAPI 調(diào)用

  無需編寫代碼，在調(diào)用頁面中填寫請求參數(shù)，便可調(diào)用 OpenAPI 。

• 查看 OpenAPI 請求

  根據(jù)您填寫的請求參數(shù)自動生成 OpenAPI 請求，并打印到網(wǎng)頁上，讓您直觀地查看到真實發(fā)送的 OpenAPI 請求。

• 結(jié)構(gòu)化輸出返回結(jié)果

  根據(jù) OpenAPI 請求，返回真實的 OpenAPI 調(diào)用結(jié)果，結(jié)構(gòu)化輸出。

• 生成 SDK 調(diào)用示例

  根據(jù)輸入的 OpenAPI 請求參數(shù)，自動生成多種語言的 SDK 調(diào)用示例。

• 命令行調(diào)用

  提供網(wǎng)頁版命令行工具，模擬 Linux 操作體驗使用命令行調(diào)用 OpenAPI 。

使用場景

查看 OpenAPI 文檔

OpenAPI 門戶提供完整的 OpenAPI 文檔，包含接口說明、流控信息、授權(quán)信息、請求參數(shù)、返回數(shù)據(jù)、返回說明、返回示例、錯誤碼、變更歷史等。您可通過閱讀 OpenAPI 文檔判斷它是否能夠滿足您的業(yè)務場景。

OpenAPI 調(diào)試

在基于阿里云 OpenAPI 進行二次開發(fā)前，您可以預先驗證 OpenAPI 請求方式，入?yún)⒑筒榭?span data-tag="ph" id="9363d5c118vuj" docid="4256301" class="ph"> OpenAPI 的返回結(jié)果。 OpenAPI 門戶提供了網(wǎng)頁和命令行兩種方式調(diào)用 OpenAPI ，讓您直觀地查看 OpenAPI 的調(diào)用結(jié)果。而且，當調(diào)用出錯時， OpenAPI 門戶會提示您如何解決，幫助您快速了解 OpenAPI 功能及使用方法。

命令行調(diào)試

如果您打算編寫 Shell 腳本來管理云資源，但又不清楚該如何編寫操作云資源的命令，可訪問 OpenAPI 門戶的API 調(diào)試界面，選擇 CLI 示例，查看命令行。

集成阿里云SDK

OpenAPI 門戶支持用戶通過集成阿里云SDK來完成API調(diào)用。在產(chǎn)品主頁的 SDK 目錄中，列舉了云產(chǎn)品 SDK 支持的語言。您可根據(jù)實際業(yè)務需要的語言和集成方式將 SDK 引入到您的項目中。并且

在您使用 SDK 進行開發(fā)時，往往需要一些代碼示例來輔助您進行開發(fā)。在 OpenAPI 門戶中輸入 API 請求參數(shù)的同時，會幫您生成 Java、PHP、Python、Node.js 等示例代碼，以引導您進行開發(fā)。并且在對應語言的 SDK 頁面，有 SDK 集成示例代碼，幫助您快速完成集成工作。

集成CDK

阿里云資源編排（ROS）支持通過 CDK 定義資源，完成資源創(chuàng)建和配置，實現(xiàn)自動化部署及運維。 OpenAPI 門戶提供 CDK 的集成調(diào)試、生成代碼示例等。