检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
安全 责任共担 身份认证与访问控制 服务韧性 认证证书
” API文档按照模板进行写作 本条规则是Should类型的扩展规则,可提升API调用者的使用体验。 API对外开放时,API文档建议使用统一的模板,以便保持API参考文档的一致性,易于开发者理解。在API参考文档中必须包含如下内容: API目录,包括本次提供API的列表信息。 API名称及API功能介绍。
每个API建议带上版本号,保证API的版本显性化,容易被API调用者所识别。版本号建议放置在URI中,用于显性标识所请求的API版本。 服务所提供的API版本定义统一规范成“vX”,这里X是一个正整数如:v1,v2等,要在API版本文档中明确在接口中说明清楚哪个版本号是目前服务主推的版本,哪些版本是支持
产品优势 API生产便捷高效 通过对接集成,API中心为开发者引入API生产工具:API Arts。 API设计、测试一站式高效协同,API数据自动同步。 API设计与文档实时同步,设计即文档。 API测试与设计同源,设计示例一键导入测试步骤。 API开放简单体验 一键上架:AP
开放API 上架API至API中心门户网站 注册API到网关代理
与其他服务的关系 API Arts API中心将API Arts作为API生产工具提供给API开发者,并支持API开发者将工具中的API文档一键发布到API中心进行分享和开放。 API Explorer API中心对接集成API Explorer,并将其作为API中心的API调试
API工具库 该页面展示的是一些开发API的工具。通过这个页面的工具可以开发API,然后通过创建API资产,将开发好的API分享至API中心。 操作步骤 下面以API Arts工具为例,描述如何开发API并上架API至API中心门户网站。 进入API中心服务页面。 选择左侧导航栏中的“API工具库”。
消费API 使用场景 如果您需要在API中心门户网站搜索需要的API,用于系统集成和项目开发,请参考本章指导操作。 操作步骤 访问API中心门户网站。 搜索您需要的API。 您可以选择搜索栏搜索或按不同维度搜索API。 搜索栏搜索:输入您需要的API的一些关键信息,如API名称、描述等,系统会展示相关的搜索结果。
API门户 您可以在API中心门户网站搜索行业价值API,用于您的系统集成和项目开发使用。支持以下两种方式访问API中心门户网站: 直接访问API中心门户网站。 进入API中心服务页面。,单击左侧导航栏中的“API门户”链接,跳转至API中心门户网站。 API中心门户网站支持用户在免登录情况下搜索和查看API。
修订记录 发布日期 修订记录 2023-05-31 第七次正式发布。 优化如下章节: 上架API至API中心门户网站 2023-03-31 第六次正式发布。 优化如下章节: 上架API至API中心门户网站 消费API 2023-03-22 第五次正式发布。 优化如下章节: 生产API
修订记录 发布日期 修订记录 2023-07-14 第九次正式发布。 优化如下章节: 服务商入驻 变更服务商信息 API资产管理 2023-05-06 第八次正式发布。 新增如下章节: 取消入驻服务商 优化如下章节: 服务商入驻 变更服务商信息 负载通道 2023-03-31 第七次正式发布。
可用性 API请求URI中如果存在特殊字符,需要进行转义编码 本条规则是MUST类型的基本规则,可保障API的高可用性。 某些字符,由于有特殊含义或者系统保留,容易被Web应用防火墙或者安全访问控制产品所阻断,导致URI调用不生效,因此不建议在URI中使用,如果必须要用需要用转义编码替换。
修订记录 发布日期 修订记录 2023-09-27 第八次正式发布。 新增如下章节: 附录-API治理规范指导 2023-07-14 第七次正式发布。 优化如下章节: 约束与限制 2023-05-22 第六次正式发布。 新增如下章节: 图解API中心 优化如下章节: 产品优势 2023-03-31
服务韧性 API中心提供了4级可靠性架构,通过全局部件跨Region容灾、Region部件跨AZ容灾、AZ内集群容灾、数据库主备容灾,保障服务的持久性与可靠性。 表1 API中心可靠性架构 可靠性方案 简要说明 跨Region容灾 全局级部件支持跨Region容灾,当主Regio
修订记录 发布日期 修订记录 2023-05-06 第四次正式发布。 新增如下章节: 服务商入驻成功后可以取消入驻吗? 服务商入驻成功后信息还可以修改吗? 2023-04-10 第三次正式发布。 优化如下章节: 为什么要申请入驻服务商? 申请入驻API中心服务商有哪些入口? 服务商入驻审核多久通过?