检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如果您需要在API中心门户网站搜索需要的API,用于系统集成和项目开发,请参考本章指导操作。 操作步骤 访问API中心门户网站。 搜索您需要的API。 您可以选择搜索栏搜索或按不同维度搜索API。 搜索栏搜索:输入您需要的API的一些关键信息,如API名称、描述等,系统会展示相关的搜索结果。 按不同维度搜索:
可维护性 API需要保持向后兼容性 本条规则是MUST类型的基本规则,可保障API的可维护性。 现网API版本一般保留3个版本或以下,如果超过3个版本会增加API本身的维护量,建议对旧版本API进行下线处理。 服务端API改动必须保证所有的服务消费者不被破坏。API是服务端和客户
简介 目的 主要用于指导伙伴、开发者在华为云API中心生产和开放API。通过统一的API治理框架和规范,帮助伙伴、开发者构建并提供有质量保障的API服务,为平台营造良好能力开放与交互的环境,支撑华为云和伙伴及开发者共建API生态。 API治理规范主要从安全、可用性、易用性、可维护
在开放API前,您需要为API分组绑定独立域名,API调用者通过独立域名访问分组内的API。您也可以使用系统分配的调试域名访问API分组内的API。 调试域名:API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名唯一且不可更改,每天最多可以访问1000次。 独立域
(可选)配置默认后端的系统参数。如果后端服务需要接收系统运行时产生的参数信息,如网关内置参数,可以通过设置系统参数来实现。API网关代理向后端服务发送请求时,将系统参数添加到请求的指定位置,然后将请求发送给后端服务。 在“系统参数”下,单击“添加系统参数”,添加后端服务请求的系统参数。 表7
PI的测试环境,开发环境等。 环境定义了API生命周期管理过程中的不同状态,API可以被发布到不同的自定义环境中。 调用不同环境的API,一般通过在API调用的请求头增加指定的头部参数,头部参数名固定为x-stage,它的取值为环境名,用以区分不同的环境。 环境变量 在环境上创建
应用场景 API设计开发 当前面临的主要问题 缺少高效的生产作业平台。 多系统数据不互通、学习成本高、数据一致性困难、效率低、无法团队协作。 API中心解决方案 API中心从华为云或生态伙伴选型轻量化、具备便捷开发体验(高效协同、自动化等)的API工具,并对接集成引入到API中心的API工具库,供API开发者使用。
按服务商维度展示:展示所有API资产的服务商。可以在左侧勾选分类,按行业筛选API资产服务商。单击服务商,可以看到该服务商拥有的所有API资产。 查看系统精选API 勾选“仅看精选”,界面会展示系统为您精选的API资产。 查看API 搜索到符合您要求的API后,单击API资产,查看API资产的开发文档,可以查看API的详细信息。
可以自定义配置AppKey和AppSecret。AppKey是身份标识,需要保证全局唯一。 如果没有特殊需求,不建议使用“自定义配置”,系统会默认生成全局标识,可在凭据详情中查看。 单击“确定”,创建凭据。 创建凭据成功后,在凭据管理页面显示新建凭据和凭据ID。 单击凭据名称,
错误码 用户调用API失败时,系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment.
API请求URI中如果存在特殊字符,需要进行转义编码 本条规则是MUST类型的基本规则,可保障API的高可用性。 某些字符,由于有特殊含义或者系统保留,容易被Web应用防火墙或者安全访问控制产品所阻断,导致URI调用不生效,因此不建议在URI中使用,如果必须要用需要用转义编码替换。 转义说明可参考:RFC
API发布是API生命周期中重要的部分,因此在发布过程中需要保证API的正确性、可读性、可用性,并对服务质量进行约束。 必须对API进行统一注册和统一管理,API注册目标系统为API中心。在API发布过程中必须保证API注册信息的准确性,保证API符合国家法规以及安全规定的要求。 API调用成功率>=99.99%
企业对外开放API供外部伙伴/开发者调用集成 操作场景 企业期望将自身业务能力(如实时快递查询服务)通过API接口对外开放,供外部伙伴/开发者调用集成,构建更繁荣的业务系统生态,并且触达更广泛的业务范围。 准备工作 准备好API接口文档,推荐OpenAPI 2.0/3.0格式。 准备好API使用指南,说明AP
企业服务能力包装成标准API服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关代理,可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放及业务能力变现。API网关代理帮助您变现服务能力的同时,降低企业研发投入,让您专注于企业核心业务,提升运营效率。您需要先
1和TLS1.2,推荐使用TLS1.2。 本章描述的“用户”指的都是华为云账号。 如果API网关代理当前的配额限制无法满足您的需求,您可以向系统提交工单申请更多配额。
调用API API发布到环境后,即支持被其他用户调用。根据API所使用的安全认证方式不同,调用API的操作有所差异。 约束与限制 如果您使用系统分配的默认子域名访问API,该子域名每天最多可以访问1000次。 前提条件 在调用API前,确保您所在网络与API的访问域名或地址互通。 获取API的调用信息
Markdown压缩包:支持导入Markdown编辑的API文件,且该文件需要压缩为zip包导入。 URL:填写您API资产的URL地址,系统会将URL地址内的API资产展示在API中心。 API Arts:支持从API Arts工具直接把开发好的API文件一键式导入API中心。
Markdown压缩包:支持导入Markdown编辑的API文件,且该文件需要压缩为zip包导入。 URL:填写您API资产的URL地址,系统会将URL地址内的API资产展示在API中心。 API Arts:支持从API Arts工具直接把开发好的API文件一键式导入API中心。
图1 取消入驻 在方框中输入“我确认要取消入驻API中心服务商”(可单击右侧复制文字),单击“确定”。 图2 确认取消入驻 取消入驻成功后,系统提示“取消入驻成功”,并返回入驻API中心服务商界面。 父主题: 服务商
API名称 系统默认自动生成一个API名称,建议按照一定的命名规则填写,方便后期快速识别和查找。 所属分组 默认创建API分组中已创建分组。 URL 请求方法:接口调用方式,此处选择“GET”。 请求协议:选择协议类型,此处选择“HTTPS”。 子域名:创建API分组时,系统默认分配的一个子域名。