10大功能特性,助力開(kāi)發(fā)者玩轉(zhuǎn)華為云API Explorer
伴隨著我國(guó)API生態(tài)逐漸成熟、市場(chǎng)發(fā)展不斷完善,API已廣泛應(yīng)用在以網(wǎng)頁(yè)、移動(dòng)應(yīng)用、后端系統(tǒng)集成為主的眾多開(kāi)發(fā)場(chǎng)景中。同時(shí),開(kāi)發(fā)者對(duì)API的主要訴求已由獲取數(shù)據(jù)能力轉(zhuǎn)變?yōu)楂@取技術(shù)能力、甚至業(yè)務(wù)能力,開(kāi)發(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è)開(kāi)發(fā)人員需要引入和維護(hù)的API也越多。開(kāi)發(fā)者面臨以下難題:
面對(duì)冗雜的API說(shuō)明文檔,查閱困難
調(diào)試接口或排除故障時(shí)無(wú)法可視化處理
從0開(kāi)始開(kāi)發(fā)底層代碼,降低效率
運(yùn)維人員需在控制臺(tái)上配置并管理云資源
?
為解決開(kāi)發(fā)者的以上難題,華為云API Explorer為開(kāi)發(fā)者提供一站式API解決方案統(tǒng)一平臺(tái),集成華為云服務(wù)所有開(kāi)放API,支持全量快速檢索、可視化調(diào)試、幫助文檔、代碼示例等能力,幫助開(kāi)發(fā)者快速查找、學(xué)習(xí)API和使用API開(kāi)發(fā)代碼。
?
滿足開(kāi)發(fā)者應(yīng)用開(kāi)發(fā)全場(chǎng)景
華為云API Explorer開(kāi)放平臺(tái)全方位助力開(kāi)發(fā)者的各類(lèi)應(yīng)用開(kāi)發(fā)場(chǎng)景,包括但不限于微服務(wù)場(chǎng)景、App場(chǎng)景、Web場(chǎng)景、IoT場(chǎng)景、AI場(chǎng)景、小程序場(chǎng)景等,支持18大類(lèi)194+產(chǎn)品服務(wù),7000+開(kāi)放API,搭載華為云計(jì)算、網(wǎng)絡(luò)、存儲(chǔ)、應(yīng)用服務(wù)、軟件開(kāi)發(fā)服務(wù)、視頻、數(shù)據(jù)庫(kù)、EI智能等200+產(chǎn)品服務(wù),8900+API和15000+錯(cuò)誤碼,590?個(gè)SDK。

10大功能特性,助力開(kāi)發(fā)者玩轉(zhuǎn)API Explorer
API在線搜索
華為云API Explorer的API在線搜索功能,可幫助開(kāi)發(fā)者快速檢索,支持開(kāi)發(fā)者基于API Explorer全局搜索云產(chǎn)品服務(wù)或API,同時(shí)支持開(kāi)發(fā)者按產(chǎn)品搜索API。開(kāi)發(fā)者在登錄后,也可通過(guò)API Explorer門(mén)戶快速查看最近搜索/使用的產(chǎn)品或API。開(kāi)發(fā)者也可在API Explorer上關(guān)注常用產(chǎn)品API。

API參數(shù)可視化調(diào)試
API Explorer支持常用YAML定義參數(shù)表格化、可視化,可見(jiàn)即得的參數(shù)描述及示例說(shuō)明,可幫助開(kāi)發(fā)者快速理解參數(shù)結(jié)構(gòu),并支持開(kāi)發(fā)者在線可視化調(diào)試API,并可根據(jù)自動(dòng)獲取的錯(cuò)誤碼詳情,快速定位問(wèn)題、解決問(wèn)題,從而提高開(kāi)發(fā)效率。在全新升級(jí)的API Explorer中,開(kāi)發(fā)者在登錄狀態(tài)下,可自動(dòng)獲取Region、Token、Project_id參數(shù)值,避免開(kāi)發(fā)者人工查找,提高調(diào)試效率。

API文檔
API文檔包含了規(guī)范的文檔結(jié)構(gòu)、接口說(shuō)明、請(qǐng)求參數(shù)/示例、返回參數(shù)/示例、錯(cuò)誤碼、SDK等,開(kāi)發(fā)者可以快速查閱API詳情和參數(shù)說(shuō)明,并可通過(guò)文檔上的相關(guān)鏈接了解云產(chǎn)品的服務(wù)功能

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

SDK中心
華為云全新設(shè)計(jì)的SDK V3版本,提供統(tǒng)一的SDK使用方式。開(kāi)發(fā)者可通過(guò)添加依賴或下載的方式調(diào)用華為云API,訪問(wèn)華為云應(yīng)用、資源和數(shù)據(jù)。SDK為開(kāi)發(fā)者提供詳細(xì)的代碼示例,便于開(kāi)發(fā)者快速集成、快速開(kāi)發(fā)。
錯(cuò)誤碼搜索查看
API Explorer提供產(chǎn)品全部錯(cuò)誤碼的搜索查看功能,開(kāi)發(fā)者可基于全局或在產(chǎn)品內(nèi)搜索錯(cuò)誤碼,根據(jù)錯(cuò)誤碼說(shuō)明解決問(wèn)題。

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

Terraform Explorer
開(kāi)發(fā)者可通過(guò)?Terraform?在線、可視化地創(chuàng)建、管理、編排華為云資源,并對(duì)其進(jìn)行版本控制。
?
?
API Explorer快速入門(mén)
在使用API Explorer前,您需要完成如下準(zhǔn)備工作:
注冊(cè)華為賬號(hào)
完成實(shí)名認(rèn)證
創(chuàng)建IAM用戶并授權(quán)
獲取訪問(wèn)密鑰(AK/SK)
?
完成后,即可進(jìn)入API Explorer進(jìn)行調(diào)試。點(diǎn)擊進(jìn)入
以彈性云服務(wù)器?--?查詢API版本信息列表為例
點(diǎn)擊彈性云服務(wù)器

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

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

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

查看代碼示例(以Java語(yǔ)言為例)
?

?
小貼士:API Explorer是否收費(fèi)?
API Explorer本身是免費(fèi)的,但如果您在使用部分接口調(diào)用涉及付費(fèi)云產(chǎn)品,則會(huì)產(chǎn)生計(jì)費(fèi)。例如,當(dāng)您使用API Explorer的模板創(chuàng)建代碼工程,并將代碼工程導(dǎo)入代碼倉(cāng)庫(kù)時(shí),由于該功能涉及到項(xiàng)目管理和代碼托管兩個(gè)服務(wù),因此可能由于超出這兩個(gè)服務(wù)的免費(fèi)范圍而產(chǎn)生計(jì)費(fèi)。詳情請(qǐng)見(jiàn)華為云定價(jià)。
訪問(wèn)鏈接:https://console.huaweicloud.com/apiexplorer/#/openapi/overview?utm_medium=hdc