伴隨著我國API生態(tài)逐漸成熟、市場發(fā)展不斷完善,API已廣泛應(yīng)用在以網(wǎng)頁、移動應(yīng)用、后端系統(tǒng)集成為主的眾多開發(fā)場景中。同時,開發(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è)業(yè)務(wù)需求不斷擴(kuò)大、系統(tǒng)接入的云服務(wù)不斷增多的同時,企業(yè)開發(fā)人員需要引入和維護(hù)的API也越多。開發(fā)者面臨以下難題:
面對冗雜的API說明文檔,查閱困難;
調(diào)試接口或排除故障時無法可視化處理;
從0開始開發(fā)底層代碼,降低效率;
運(yùn)維人員需在控制臺上配置并管理云資源;
…
為解決開發(fā)者的以上難題,華為云API Explorer為開發(fā)者提供一站式API解決方案統(tǒng)一平臺,集成華為云服務(wù)所有開放API,支持全量快速檢索、可視化調(diào)試、幫助文檔、代碼示例等能力,幫助開發(fā)者快速查找、學(xué)習(xí)API和使用API開發(fā)代碼。
01
滿足開發(fā)者應(yīng)用開發(fā)全場景
華為云API Explorer開放平臺全方位助力開發(fā)者的各類應(yīng)用開發(fā)場景,包括但不限于微服務(wù)場景、App場景、Web場景、IoT場景、AI場景、小程序場景等,支持18大類產(chǎn)品服務(wù),搭載 華為云計算 、網(wǎng)絡(luò)、存儲、應(yīng)用服務(wù)、軟件開發(fā)服務(wù)、視頻、 數(shù)據(jù)庫 、EI智能等200+云產(chǎn)品,9100+API、16000+錯誤碼及600+個SDK。
02
十大功能特性,助力開發(fā)者玩轉(zhuǎn)API Explorer
1、API在線搜索華為云API Explorer的API在線搜索功能,可幫助開發(fā)者快速檢索,支持開發(fā)者基于API Explorer全局搜索云產(chǎn)品服務(wù)或API,同時支持開發(fā)者按產(chǎn)品搜索API。開發(fā)者在登錄后,也可通過API Explorer門戶快速查看最近搜索/使用的產(chǎn)品或API。開發(fā)者也可在API Explorer上關(guān)注常用產(chǎn)品API。
2、API參數(shù)可視化調(diào)試API Explorer支持常用YAML定義參數(shù)表格化、可視化,可見即得的參數(shù)描述及示例說明,可幫助開發(fā)者快速理解參數(shù)結(jié)構(gòu),并支持開發(fā)者在線可視化調(diào)試API,并可根據(jù)自動獲取的錯誤碼詳情,快速定位問題、解決問題,從而提高開發(fā)效率。在全新升級的API Explorer中,開發(fā)者在登錄狀態(tài)下,可自動獲取Region、Token、Project_id參數(shù)值,避免開發(fā)者人工查找,提高調(diào)試效率。
3、API文檔API文檔包含了規(guī)范的文檔結(jié)構(gòu)、接口說明、請求參數(shù)/示例、返回參數(shù)/示例、錯誤碼、SDK等,開發(fā)者可以快速查閱API詳情和參數(shù)說明,并可通過文檔上的相關(guān)鏈接了解云產(chǎn)品的服務(wù)功能
4、代碼示例代碼示例功能支持開發(fā)者使用Java、Python、Go、.NET、PHP、C、C++等多種主流開發(fā)語言調(diào)用SDK來訪問華為云開放API,幫助開發(fā)者快速了解API的底層工作原理,開發(fā)者在基于華為云服務(wù)進(jìn)行應(yīng)用開發(fā)時,可以直接引用示例代碼,避免開發(fā)者重復(fù)開發(fā)底層代碼,提高編程效率。
5、 SDK中心 華為云全新設(shè)計的SDK V3版本,提供統(tǒng)一的SDK使用方式。開發(fā)者可通過添加依賴或下載的方式調(diào)用華為云API,訪問華為云應(yīng)用、資源和數(shù)據(jù)。SDK為開發(fā)者提供詳細(xì)的代碼示例,便于開發(fā)者快速集成、快速開發(fā)。
6、錯誤碼搜索查看API Explorer提供產(chǎn)品全部錯誤碼的搜索查看功能,開發(fā)者可基于全局或在產(chǎn)品內(nèi)搜索錯誤碼,根據(jù)錯誤碼說明解決問題。
7、API問答開發(fā)者可以使用華為云API問答助手,對API、SDK、報錯解決方案、云產(chǎn)品等問題進(jìn)行咨詢,快速獲取解決方案,同時開發(fā)者可在API問答界面中提交工單、提出建議反饋等
8、API診斷當(dāng)開發(fā)者開發(fā)、調(diào)試華為云API出現(xiàn)錯誤時,可使用API診斷服務(wù)查詢解決方案、調(diào)用鏈路、CLS日志、相似錯誤碼、API文檔等信息。
9、CLI參數(shù)生成開發(fā)者在安裝部署、變更升級、擴(kuò)容等場景下,可以使用命令行的方式調(diào)用OpenAPI,管理和使用各類云服務(wù)資源,API參數(shù)可自動生成CLI命令行參數(shù),開發(fā)者可使用CLI示例在線調(diào)試。開發(fā)者也可以使用華為云命令行工具服務(wù)(KooCLI)完成以上操作。
10、Terraform Explorer開發(fā)者可通過 Terraform 在線、可視化地創(chuàng)建、管理、編排華為云資源,并對其進(jìn)行版本控制。
03
API Explorer快速入門
在使用API Explorer前,您需要完成如下準(zhǔn)備工作:
https://support.huaweicloud.com/usermanual-account/account_id_001.html
- 完成實名認(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)入華為云API Explorer進(jìn)行調(diào)試↓ 碼上「進(jìn)入」↓
以彈性 云服務(wù)器 -- 查詢API版本信息列表為例
1、點擊彈性云服務(wù)器
2、點擊查詢API版本信息 – NovaListVersions(查詢API版本信息列表)
3、點擊“調(diào)試”按鈕
4、查看調(diào)試結(jié)果及錯誤碼
5、查看代碼示例(以Java語言為例)
04
小貼士:API Explorer是否收費(fèi)?
API Explorer本身是免費(fèi)的,但如果您在使用部分接口調(diào)用涉及付費(fèi)云產(chǎn)品,則會產(chǎn)生計費(fèi)。例如,當(dāng)您使用API Explorer的模板創(chuàng)建代碼工程,并將代碼工程導(dǎo)入代碼倉庫時,由于該功能涉及到項目管理和代碼托管兩個服務(wù),因此可能由于超出這兩個服務(wù)的免費(fèi)范圍而產(chǎn)生計費(fèi)。詳情請見華為云 定價 。