检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
注册API到网关代理 使用场景 如果您想要将已开发好的API注册到API中心网关,请参考本章指导操作。 前提条件 已完成服务商入驻,具体操作指导参考《用户指南》服务商入驻章节。 使用流程 作为API提供者开放API,您需要先后完成以下流程: 步骤1:创建API分组 进入API中心服务页面。
工具平台 API生产阶段 API中心通过对接集成,为API开发者提供API Arts等自动化的API设计/开发/测试工具,开发者通过华为云账号登录后即可使用。 API开放阶段 API开发者(API提供方)可以在API中心申请入驻为服务商,然后自助发布上架API。上架成功后,API
本章指导操作。 前提条件 仅允许华为云账号取消入驻服务商,不允许该账号下的IAM用户取消入驻服务商。 已删除该华为云账号及其下的IAM用户注册在API网关代理的所有API。 已删除该华为云账号及其下的IAM用户分享在API中心门户网站的所有API资产。 操作步骤 进入API中心服务页面。
配置API请求参数后,单击“调试”。 在页面下方返回结果回显区域打印API调用的Response信息。 调用成功时,返回HTTP状态码为“200”和Response信息。 调试失败时,返回HTTP状态码为4xx或5xx,具体错误信息请参见错误码。 您可以通过调整请求参数与参数值,发送不同的请求,验证API服务。
表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment. 检查域名、方法、路径和注册的API是否一致。 检查AP
开放API: 上架API至API中心门户网站:通过创建API资产,将您开发好的API分享在API中心门户网站,供其他开发者调用。 注册API到网关代理:将您的API注册到API网关代理,使您的服务能力变现,同时降低企业研发投入,让您专注于企业核心业务,提升运营效率。 消费API:在API中
Arts将开发好的API文件一键式导入API中心。 支持区域: 华北-北京四 使用API Arts开发API API资产分享 API中心服务商可以通过在管理控制台创建API资产,将开发好的API分享至API中心门户网站,供其他开发者集成和调用。 支持区域: 华北-北京四 创建API资产 API网关注册 AP
单击页面右上角的“创建API资产”。 填写API资产信息。 根据表1参数信息,配置选择导入API。 表1 选择导入API 参数名称 说明 导入方式 支持以下6种方式,上架API文件至API中心门户网站: OpenAPI:支持导入符合OpenAPI 2.0/3.0标准的txt、yml、yaml、json格式的API文件。
导入API API网关代理支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。
是否必须使用API中心的网关代理功能? 不是。如果您的API已经注册在自有网关或者其他第三方网关,API中心仍然支持您创建API资产,将API展示在API中心门户网站。 父主题: API网关代理
API发布过程中必须保证API注册信息的准确性 本条规则是MUST类型的基本规则,可保障API的高可用性。 API发布是API生命周期中重要的部分,因此在发布过程中需要保证API的正确性、可读性、可用性,并对服务质量进行约束。 必须对API进行统一注册和统一管理,API注册目标系统为API中
开放API 上架API至API中心门户网站 注册API到网关代理
单击页面右上角的“创建API资产”。 填写API资产信息。 根据表1参数信息,配置选择导入API。 表1 选择导入API 参数名称 说明 导入方式 支持以下6种方式,上架API文件至API中心门户网站: OpenAPI:支持导入符合OpenAPI 2.0/3.0标准的txt、yml、yaml、json格式的API文件。
Gateway(Application Programming Interface gateway,API网关)是当前API的一个公共服务,是所有API注册和发布的入口。 JSON JSON(JavaScript Object Notation) 是一个轻量级的数据交换格式,它易于人类读写及其解析生成。
为API开发者和应用开发者构建的海量API的汇聚运营平台。帮助API开发者高效便捷地分享和开放API,支持应用开发者快速查找所需API并进行应用开发和集成。 此外,通过对接集成API工具、华为云商店、华为云集成工作台、低代码平台等华为云或生态伙伴相关服务或产品,为API开发者提供
API中心服务商可在API中心管理控制台管理API资产。 华北-北京四 API网关代理 API中心服务商可使用API中心的网关代理模块,进行API注册、发布,并支持配置流控策略、访问控制、签名密钥等策略来限制对API的访问。 华北-北京四 API门户 API中心门户汇聚展示千行百业API
单击页面右上角的“创建API资产”。 填写API资产信息。 根据表1参数信息,配置选择导入API。 表1 选择导入API 参数名称 说明 导入方式 支持以下6种方式,上架API文件至API中心门户网站: OpenAPI:支持导入符合OpenAPI 2.0/3.0标准的txt、yml、yaml、json格式的API文件。
计费说明 API中心当前是免费的平台服务,当前API中心平台本身并不直接面向伙伴/开发者收取费用。 API商业售卖是基于华为云云商店来实现交易和变现,该场景下计费相关信息以华为云云商店相关规定为准。
应用场景 API设计开发 当前面临的主要问题 缺少高效的生产作业平台。 多系统数据不互通、学习成本高、数据一致性困难、效率低、无法团队协作。 API中心解决方案 API中心从华为云或生态伙伴选型轻量化、具备便捷开发体验(高效协同、自动化等)的API工具,并对接集成引入到API中心的API工具库,供API开发者使用。
导入API 参数名称 说明 导入方式 导入方式包含以下2种: 生成新的分组:将API定义导入到一个新的分组,导入过程中系统会自动创建一个新的API分组,并将导入的API归属到该分组。 选择已有分组:将API定义导入到一个已有的分组,导入过程中不会删除分组中已有的API,只是将新增的API导入分组。