检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
开放API 上架API至API中心门户网站 注册API到网关代理
API开放 安全性 可用性 可维护性 生命周期管理 父主题: 规范要求
步骤6:发布API 在左侧导航栏选择“API网关代理 > API列表”。 在需要发布的API所在行,单击“操作”列的“发布”。 选择已创建的API发布环境,并填写发布说明。 图5 发布API 单击“确定”,完成发布。 后续操作 如果您需要调用注册到API网关代理的API,请参考《用户指南》调用API章节。
down编辑的API文件,且该文件需要压缩为zip包导入。 URL:填写您API资产的URL地址,系统会将URL地址内的API资产展示在API中心。 API Arts:支持从API Arts工具直接把开发好的API文件一键式导入API中心。 说明: 仅从API Arts工具导入API资产时,导入方式这里会显示“API
吞吐量(TPS)控制:指API单位时间内可并发处理的能力。 传输流量控制:指API单位时间内传输的数据量。 API发布过程中必须保证API注册信息的准确性 本条规则是MUST类型的基本规则,可保障API的高可用性。 API发布是API生命周期中重要的部分,因此在发布过程中需要保证API的正确性、可读性、可用性,并对服务质量进行约束。
URL:填写您API资产的URL地址,系统会将URL地址内的API资产展示在API中心。 API Arts:支持从API Arts工具直接把开发好的API文件一键式导入API中心。 说明: 仅从API Arts工具导入API资产时,导入方式这里会显示“API Arts”页签。 如果您的Markd
生命周期管理 API接口变更在参考文档中为新版本提供迁移计划 本条规则是Should类型的扩展规则,可方便管理API的生命周期。 在进行新版本API设计时应当考虑老版本升级迁移计划,从而实现API的迁移。新版本中继承的接口在语义上应当能兼容老版本。 对于计划不再支持的接口,需要正式发
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则,可提升API的安全性。 根据具体业务场景,选择API调用的认证模式,具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则,可保障API的可维护性。 在采集API调用日志过程中,需要保证API日志的实时性和完整性,以提升API分析的精准度。 API日志在传递过程中,必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
在API列表页,单击API所在行“操作”列的“编辑”,修改API参数信息。 创建策略并绑定API 通过对API添加策略,限制对API的访问,从而保护后端服务。 调试API 创建完API后,需要验证服务是否正常,管理控制台提供调试功能。 发布API 创建完成的API,支持发布到不同的环境。API只有在发布到环境后,才支持被调用。
产品架构 图1 API中心产品架构 API中心主要包括API工具,API门户,API网关代理,API运营四个产品模块: API工具 API中心通过对接集成API开发工具,为API开发者提供简单易用的API工具,帮助开发者高效地设计、测试API。 API门户 API中心构建面向广大
调用已发布的API 调用API 响应消息头 错误码 父主题: API网关代理
华为云 API中心 API中心(API Hub)是为API开发者和应用开发者构建的,海量API的汇聚运营平台。帮助API开发者高效便捷地分享和开放API,支持应用开发者快速查找所需API并进行应用开发和集成。API中心贯通并粘合API生产、API开放和API消费,促进API供需匹配
部分API未提供调试功能,具体以详情页面展示的信息为准。 对于需要付费购买的API(来源于华为云市场的API),单击API资产,在API资产详情页面,单击“API接口”页签下的“调试API”,在线调试API。 (可选)获取服务商联系方式。 对于不需要付费购买的API(技术开放型API),可以通过以下步骤获取API服务商的联系方式。
获取API的调用信息 在调用API前,您需要向API提供方获取API的调用信息。 获取API的请求信息 向API提供方获取API的“域名”、“请求方法”、“API URL”、“请求参数”和“Headers”。 获取API的调用凭据 根据API使用的安全认证方式不同,还要获取相关的请求认证信息,具体参考表1。
勾选“仅看精选”,界面会展示系统为您精选的API资产。 查看API 搜索到符合您要求的API后,单击API资产,查看API资产的开发文档,可以查看API的详细信息。 获取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调用的Response信息。 调用成功时,返回HTTP状态码为“200”和Response信息。
在线调测API 应用开发者可以在API中心门户网站的API详情页对支持调测的API进行在线调测,快速试用API。 支持区域: 华北-北京四 在线调测API 获取服务商联系方式 对于不需要付费购买的API,支持您在API中心门户网站的API详情页面通过订阅API,获取API服务商的联系方式。
选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。 API 默认导出API分组所在环境的所有已发布的API,如果需要导出个别API,单击“自定义导出API”,勾选需要导出的API名称。 API定义范围 基础定义:只导出API前端定义。其中API前端定义除了