摘要:华为云API Explorer为开发者提供一站式API解决方案统一平台,集成华为云服务所有开放API,支持全量快速检索、可视化调试、帮助文档、代码示例等能力,帮助开发者快速查找、学习API和使用API开发代码。
本文分享自华为云社区《10大功能特性,助力开发者玩转华为云API Explorer》,作者:华为云PaaS服务小智。
伴随着我国API生态逐渐成熟、市场发展不断完善,API已广泛应用在以网页、移动应用、后端系统集成为主的众多开发场景中。同时,开发者对API的主要诉求已由获取数据能力转变为获取技术能力、甚至业务能力,开发者渴望更加高效便捷的调用方式,除关注API产品本身性能外,也愈发关注优质的服务和使用体验。
在企业业务需求不断扩大、系统接入的云服务不断增多的同时,企业开发人员需要引入和维护的API也越多。开发者面临以下难题:
…
为解决开发者的以上难题,华为云API Explorer为开发者提供一站式API解决方案统一平台,集成华为云服务所有开放API,支持全量快速检索、可视化调试、帮助文档、代码示例等能力,帮助开发者快速查找、学习API和使用API开发代码。
华为云API Explorer开放平台全方位助力开发者的各类应用开发场景,包括但不限于微服务场景、App场景、Web场景、IoT场景、AI场景、小程序场景等,支持18大类194+产品服务,7000+开放API,搭载华为云计算、网络、存储、应用服务、软件开发服务、视频、数据库、EI智能等200+产品服务,8900+API和15000+错误码,590 个SDK。
华为云API Explorer的API在线搜索功能,可帮助开发者快速检索,支持开发者基于API Explorer全局搜索云产品服务或API,同时支持开发者按产品搜索API。开发者在登录后,也可通过API Explorer门户快速查看最近搜索/使用的产品或API。开发者也可在API Explorer上关注常用产品API。
API Explorer支持常用YAML定义参数表格化、可视化,可见即得的参数描述及示例说明,可帮助开发者快速理解参数结构,并支持开发者在线可视化调试API,并可根据自动获取的错误码详情,快速定位问题、解决问题,从而提高开发效率。在全新升级的API Explorer中,开发者在登录状态下,可自动获取Region、Token、Project_id参数值,避免开发者人工查找,提高调试效率。
API文档包含了规范的文档结构、接口说明、请求参数/示例、返回参数/示例、错误码、SDK等,开发者可以快速查阅API详情和参数说明,并可通过文档上的相关链接了解云产品的服务功能
代码示例功能支持开发者使用Java、Python、Go、.NET、PHP、C、C++等多种主流开发语言调用SDK来访问华为云开放API,帮助开发者快速了解API的底层工作原理,开发者在基于华为云服务进行应用开发时,可以直接引用示例代码,避免开发者重复开发底层代码,提高编程效率。
华为云全新设计的SDK V3版本,提供统一的SDK使用方式。开发者可通过添加依赖或下载的方式调用华为云API,访问华为云应用、资源和数据。SDK为开发者提供详细的代码示例,便于开发者快速集成、快速开发。
API Explorer提供产品全部错误码的搜索查看功能,开发者可基于全局或在产品内搜索错误码,根据错误码说明解决问题。
开发者可以使用华为云API问答助手,对API、SDK、报错解决方案、云产品等问题进行咨询,快速获取解决方案,同时开发者可在API问答界面中提交工单、提出建议反馈等
当开发者开发、调试华为云API出现错误时,可使用API诊断服务查询解决方案、调用链路、CLS日志、相似错误码、API文档等信息。
开发者在安装部署、变更升级、扩容等场景下,可以使用命令行的方式调用OpenAPI,管理和使用各类云服务资源,API参数可自动生成CLI命令行参数,开发者可使用CLI示例在线调试。开发者也可以使用华为云命令行工具服务(KooCLI)完成以上操作。
开发者可通过 Terraform 在线、可视化地创建、管理、编排华为云资源,并对其进行版本控制。
在使用API Explorer前,您需要完成如下准备工作:
完成后,即可进入API Explorer进行调试。点击进入
以弹性云服务器 -- 查询API版本信息列表为例
API Explorer本身是免费的,但如果您在使用部分接口调用涉及付费云产品,则会产生计费。例如,当您使用API Explorer的模板创建代码工程,并将代码工程导入代码仓库时,由于该功能涉及到项目管理和代码托管两个服务,因此可能由于超出这两个服务的免费范围而产生计费。详情请见华为云定价。
扫码体验华为云API Explorer
体验拦截器的高级功能,设置拦截器属性并在实现中使用此属性,这样同一个拦截器在不同位置可以发布不同效果,更可以将同一个拦截器设置不同属性,叠加使用在同一个地方