检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
开放API 上架API至API中心门户网站 注册API到网关代理
服务商入驻 为什么要申请入驻服务商? 申请入驻API中心服务商有哪些入口? 服务商入驻审核多久通过? 服务商入驻成功后可以取消入驻吗? 服务商入驻成功后信息还可以修改吗?
修订记录 发布日期 修订记录 2023-05-06 第四次正式发布。 新增如下章节: 服务商入驻成功后可以取消入驻吗? 服务商入驻成功后信息还可以修改吗? 2023-04-10 第三次正式发布。 优化如下章节: 为什么要申请入驻服务商? 申请入驻API中心服务商有哪些入口? 服务商入驻审核多久通过?
API生产 安全性 可用性 易用性 可维护性 父主题: 规范要求
API开放 安全性 可用性 可维护性 生命周期管理 父主题: 规范要求
API分组 创建API分组 域名管理 环境变量 父主题: API网关代理
API凭据管理 创建凭据并绑定API 重置Secret 为简易认证绑定AppCode 父主题: API网关代理
服务商 服务商入驻 变更服务商信息 取消入驻服务商
产品功能 表1 API中心功能概览 功能名称 功能描述 发布区域 API设计和测试 API开发者可使用API中心工具库中的API生产工具(如华为云API Arts),进行API的设计、测试等。 华北-北京四 服务商入驻 API开发者可在线申请入驻成为API中心的服务商。 华北-北京四
附录-API治理规范指导 概述 规范要求 工具平台
概述 简介 术语 父主题: 附录-API治理规范指导
规范要求 API生产 API开放 父主题: 附录-API治理规范指导
安全 责任共担 身份认证与访问控制 服务韧性 认证证书
修订记录 发布日期 修订记录 2023-09-27 第八次正式发布。 新增如下章节: 附录-API治理规范指导 2023-07-14 第七次正式发布。 优化如下章节: 约束与限制 2023-05-22 第六次正式发布。 新增如下章节: 图解API中心 优化如下章节: 产品优势 2023-03-31
图解API中心
生产API 使用场景 如果您想要使用API中心提供的工具开发API,请参考本章指导操作。 操作步骤 下面以API Arts工具为例,描述如何开发API并上架API至API中心门户网站。 进入API中心服务页面。 选择左侧导航栏中的“API工具库”。 单击API Arts工具右下角的“前往使用”,进入API
策声明》”,单击“立即提交”。 根据您是否需要使用API网关代理功能,选择对应的操作。 是:联系API中心运营人员,并告知其您需要使用API网关代理功能。 否:直接执行7。 如果入驻服务商时没有开通API网关代理功能,后续如果想要使用API网关代理,可以变更服务商信息,然后联系API中心运营人员开通此功能。
API描述信息建议使用Markdown格式编写,便于生成对应API文档,API描述信息长度建议不超过2000字符。 例如:发布API用于查询虚拟机列表。良好的API描述应为“通过虚拟机名称、IP地址、虚拟机型号查询当前租户下的虚拟机列表,列表包括虚拟机名称,所属VPC、虚拟机IP、虚拟机型号、操作系统版本。”
在进行新版本API设计时应当考虑老版本升级迁移计划,从而实现API的迁移。新版本中继承的接口在语义上应当能兼容老版本。 对于计划不再支持的接口,需要正式发布接口变更公告,应当至少提前6个月在文档标识(使用@deprecated)为不建议使用(在此期间该接口仍要能完成正常的功能),并提供替换方式的处理。 新版本
调用API API发布到环境后,即支持被其他用户调用。根据API所使用的安全认证方式不同,调用API的操作有所差异。 约束与限制 如果您使用系统分配的默认子域名访问API,该子域名每天最多可以访问1000次。 前提条件 在调用API前,确保您所在网络与API的访问域名或地址互通。