检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
安全 责任共担 身份认证与访问控制 服务韧性 认证证书
维度针对API生产(API设计/开发/测试)和API开放提供规则建议。 安全:对API的安全认证、涉及敏感信息或个人隐私数据使用和处理提出规范要求或建议,保障API的安全合规。 可用性:对API调用成功率、响应时长、并发及流量控制、吞吐量等提出规范要求或建议,保障API的高可用性。
本。” API文档按照模板进行写作 本条规则是Should类型的扩展规则,可提升API调用者的使用体验。 API对外开放时,API文档建议使用统一的模板,以便保持API参考文档的一致性,易于开发者理解。在API参考文档中必须包含如下内容: API目录,包括本次提供API的列表信息。
环境管理 API可以同时提供给不同的环境调用,如生产、测试或开发。RELEASE是默认存在的环境,无需创建。 创建环境 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 单击“环境管理”页签。 单击“创建环境”,填写环境信息。 表1 环境信息 信息项
导入API API网关代理支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。
API凭据管理 创建凭据并绑定API 重置Secret 为简易认证绑定AppCode 父主题: API网关代理
API工具库 该页面展示的是一些开发API的工具。通过这个页面的工具可以开发API,然后通过创建API资产,将开发好的API分享至API中心。 操作步骤 下面以API Arts工具为例,描述如何开发API并上架API至API中心门户网站。 进入API中心服务页面。 选择左侧导航栏中的“API工具库”。
API生产 安全性 可用性 易用性 可维护性 父主题: 规范要求
API开放 安全性 可用性 可维护性 生命周期管理 父主题: 规范要求
如果是来源于华为云市场的API商品,可按照页面提示完成购买,然后在“买家中心>已购买的服务”中看到商品信息,单击“资源详情”可查看API调用凭据(AppKey/AppSecret)。 如果是其他来源的技术开放型API,可根据API使用指南或者联系API服务商获取API调用凭据。 父主题:
调用已发布的API 调用API 响应消息头 错误码 父主题: API网关代理
API网关代理 概述 API分组 API列表 API策略 API凭据管理 调用已发布的API
Key唯一且不可重置,Secret支持重置。重置完成后,原先的Secret将失效,绑定此凭据的API将无法调用,请更新SDK中的密钥对,并重新调用API。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API凭据管理”。 在“凭据管理”页面,单击凭据名称,进入详情页面。 单击“重置Secret”。
概述 API网关代理包括API的创建、发布、下线和删除所经历的完整生命周期过程,为您提供高性能、高可用、高安全的API托管服务,能快速将企业服务能力包装成标准API服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关代理,可以简单、快速、低成本、低风险地实现内部系统集
参数名称 含义 API总数 API网关代理中,已创建的API的总个数。数据1个小时刷新一次。 API分组总数 API网关代理中,已创建的API分组的总个数。数据1个小时刷新一次。 API请求总数 API网关代理中,已发布的所有API被调用的总次数。数据10分钟刷新一次。 API请求失败总数
图解API中心
API网关代理 是否必须使用API中心的网关代理功能? 哪些API支持在线调测? 如何获取API调用凭据?
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则,可提升API的安全性。 根据具体业务场景,选择API调用的认证模式,具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
响应消息头 调用API时,API网关代理增加如下响应消息头。 X-Apig-Mode: debug表示响应消息头增加API网关代理调试信息。 响应消息头 描述 说明 X-Request-Id 请求ID 所有合法请求,都会返回此参数 X-Apig-Latency 从API网关代理接收请求到后端返回消息头的用时
API售卖与技术支持 如何对API进行商业售卖? 谁为API使用者提供技术支持?