十大功能特性，助力開發(fā)者玩轉(zhuǎn) API?Explorer

伴隨著我國 API 生態(tài)逐漸成熟、市場發(fā)展不斷完善，API 已廣泛應(yīng)用在以網(wǎng)頁、移動(dòng)應(yīng)用、后端系統(tǒng)集成為主的眾多開發(fā)場景中。同時(shí)，開發(fā)者對 API 的主要訴求已由獲取數(shù)據(jù)能力轉(zhuǎn)變?yōu)楂@取技術(shù)能力、甚至業(yè)務(wù)能力，開發(fā)者渴望更加高效便捷的調(diào)用方式，除關(guān)注 API 產(chǎn)品本身性能外，也愈發(fā)關(guān)注優(yōu)質(zhì)的服務(wù)和使用體驗(yàn)。在企業(yè)業(yè)務(wù)需求不斷擴(kuò)大、系統(tǒng)接入的云服務(wù)不斷增多的同時(shí)，企業(yè)開發(fā)人員需要引入和維護(hù)的 API 也越多。開發(fā)者面臨以下難題：

面對冗雜的 API 說明文檔，查閱困難；

調(diào)試接口或排除故障時(shí)無法可視化處理；

從 0 開始開發(fā)底層代碼，降低效率；

運(yùn)維人員需在控制臺上配置并管理云資源；

…

為解決開發(fā)者的以上難題，華為云 APIExplorer 為開發(fā)者提供一站式 API 解決方案統(tǒng)一平臺，集成華為云服務(wù)所有開放 API，支持全量快速檢索、可視化調(diào)試、幫助文檔、代碼示例等能力，幫助開發(fā)者快速查找、學(xué)習(xí) API 和使用 API 開發(fā)代碼。

01

滿足開發(fā)者應(yīng)用開發(fā)全場景

華為云 APIExplorer 開放平臺全方位助力開發(fā)者的各類應(yīng)用開發(fā)場景，包括但不限于微服務(wù)場景、App 場景、Web 場景、IoT 場景、AI 場景、小程序場景等，支持18大類產(chǎn)品服務(wù)，搭載華為云計(jì)算、網(wǎng)絡(luò)、存儲、應(yīng)用服務(wù)、軟件開發(fā)服務(wù)、視頻、數(shù)據(jù)庫、EI 智能等200+云產(chǎn)品，9100+API、16000+錯(cuò)誤碼及600+個(gè) SDK。

02

十大功能特性，助力開發(fā)者玩轉(zhuǎn) APIExplorer

●API 在線搜索華為云 APIExplorer 的 API 在線搜索功能，可幫助開發(fā)者快速檢索，支持開發(fā)者基于 APIExplorer 全局搜索云產(chǎn)品服務(wù)或 API，同時(shí)支持開發(fā)者按產(chǎn)品搜索 API。開發(fā)者在登錄后，也可通過 APIExplorer 門戶快速查看最近搜索/使用的產(chǎn)品或 API。開發(fā)者也可在 APIExplorer 上關(guān)注常用產(chǎn)品 API。

●API 參數(shù)可視化調(diào)試APIExplorer支持常用 YAML 定義參數(shù)表格化、可視化，可見即得的參數(shù)描述及示例說明，可幫助開發(fā)者快速理解參數(shù)結(jié)構(gòu)，并支持開發(fā)者在線可視化調(diào)試 API，并可根據(jù)自動(dòng)獲取的錯(cuò)誤碼詳情，快速定位問題、解決問題，從而提高開發(fā)效率。在全新升級的 APIExplorer 中，開發(fā)者在登錄狀態(tài)下，可自動(dòng)獲取 Region、Token、Project_id 參數(shù)值，避免開發(fā)者人工查找，提高調(diào)試效率?！馎PI 文檔API 文檔包含了規(guī)范的文檔結(jié)構(gòu)、接口說明、請求參數(shù)/示例、返回參數(shù)/示例、錯(cuò)誤碼、SDK 等，開發(fā)者可以快速查閱 API 詳情和參數(shù)說明，并可通過文檔上的相關(guān)鏈接了解云產(chǎn)品的服務(wù)功能

●代碼示例代碼示例功能支持開發(fā)者使用 Java、Python、Go、.NET、PHP、C、C++等多種主流開發(fā)語言調(diào)用 SDK 來訪問華為云開放 API，幫助開發(fā)者快速了解 API 的底層工作原理，開發(fā)者在基于華為云服務(wù)進(jìn)行應(yīng)用開發(fā)時(shí)，可以直接引用示例代碼，避免開發(fā)者重復(fù)開發(fā)底層代碼，提高編程效率。

●SDK 中心華為云全新設(shè)計(jì)的 SDKV3 版本，提供統(tǒng)一的 SDK 使用方式。開發(fā)者可通過添加依賴或下載的方式調(diào)用華為云 API，訪問華為云應(yīng)用、資源和數(shù)據(jù)。SDK 為開發(fā)者提供詳細(xì)的代碼示例，便于開發(fā)者快速集成、快速開發(fā)。

●錯(cuò)誤碼搜索查看APIExplorer 提供產(chǎn)品全部錯(cuò)誤碼的搜索查看功能，開發(fā)者可基于全局或在產(chǎn)品內(nèi)搜索錯(cuò)誤碼，根據(jù)錯(cuò)誤碼說明解決問題。

●API 問答開發(fā)者可以使用華為云 API 問答助手，對 API、SDK、報(bào)錯(cuò)解決方案、云產(chǎn)品等問題進(jìn)行咨詢，快速獲取解決方案，同時(shí)開發(fā)者可在 API 問答界面中提交工單、提出建議反饋等●API 診斷當(dāng)開發(fā)者開發(fā)、調(diào)試華為云 API 出現(xiàn)錯(cuò)誤時(shí)，可使用 API 診斷服務(wù)查詢解決方案、調(diào)用鏈路、CLS 日志、相似錯(cuò)誤碼、API 文檔等信息?！馛LI 參數(shù)生成開發(fā)者在安裝部署、變更升級、擴(kuò)容等場景下，可以使用命令行的方式調(diào)用 OpenAPI，管理和使用各類云服務(wù)資源，API 參數(shù)可自動(dòng)生成 CLI 命令行參數(shù)，開發(fā)者可使用 CLI 示例在線調(diào)試。開發(fā)者也可以使用華為云命令行工具服務(wù)（KooCLI）完成以上操作。

●TerraformExplorer開發(fā)者可通過Terraform在線、可視化地創(chuàng)建、管理、編排華為云資源，并對其進(jìn)行版本控制。

03

APIExplorer 快速入門

在使用 APIExplorer 前，您需要完成如下準(zhǔn)備工作：

注冊華為賬號

https://support.huaweicloud.com/usermanual-account/account_id_001.html

完成實(shí)名認(rèn)證

https://support.huaweicloud.com/usermanual-account/account_auth_00001.html

創(chuàng)建 IAM 用戶并授權(quán)

https://support.huaweicloud.com/qs-iam/iam_01_0030.html

獲取訪問密鑰（AK/SK）

https://support.huaweicloud.com/devg-apisign/api-sign-provide-aksk.html

完成后進(jìn)入華為云 APIExplorer進(jìn)行調(diào)試↓碼上「進(jìn)入」↓

以彈性云服務(wù)器--查詢 API 版本信息列表為例

點(diǎn)擊彈性云服務(wù)器

點(diǎn)擊查詢 API 版本信息–NovaListVersions（查詢 API 版本信息列表）

點(diǎn)擊“調(diào)試”按鈕

查看調(diào)試結(jié)果及錯(cuò)誤碼

查看代碼示例（以 Java 語言為例）

04

小貼士：APIExplorer 是否收費(fèi)？

APIExplorer 本身是免費(fèi)的，但如果您在使用部分接口調(diào)用涉及付費(fèi)云產(chǎn)品，則會產(chǎn)生計(jì)費(fèi)。例如，當(dāng)您使用 APIExplorer 的模板創(chuàng)建代碼工程，并將代碼工程導(dǎo)入代碼倉庫時(shí)，由于該功能涉及到項(xiàng)目管理和代碼托管兩個(gè)服務(wù)，因此可能由于超出這兩個(gè)服務(wù)的免費(fèi)范圍而產(chǎn)生計(jì)費(fèi)。詳情請見華為云定價(jià)。

審核編輯 黃宇