检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
服务商 服务商入驻 变更服务商信息 取消入驻服务商
安全 责任共担 身份认证与访问控制 服务韧性 认证证书
图解API中心 优化如下章节: 产品优势 2023-03-31 第五次正式发布。 优化如下章节: 什么是API中心 应用场景 产品功能 与其他服务的关系 2023-03-22 第四次正式发布。 优化如下章节: 产品功能 2023-03-03 第三次正式发布。 优化如下章节: 产品功能 2023-02-10
图解API中心
附录-API治理规范指导 概述 规范要求 工具平台
概述 简介 术语 父主题: 附录-API治理规范指导
规范要求 API生产 API开放 父主题: 附录-API治理规范指导
发布API 创建完成的API,支持发布到不同的环境。API只有在发布到环境后,才支持被调用。API网关代理支持查看API发布历史(如版本、发布说明、发布时间和发布环境),并支持回滚到不同的API历史版本。 已发布的API,在修改信息后,需要重新发布才能将修改后的信息同步到环境中。
创建API分组成功后,您还可以执行如表3的操作。 表3 后续操作 操作 说明 为API分组绑定独立域名 在开放API前,您需要为API分组绑定独立域名,API调用者通过独立域名访问分组内的API。 添加环境变量 通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。 修改分组信息 在分组所在行“
API入参/出参设计必须考虑开发者易于使用 本条规则是Should类型的扩展规则,可提升API调用者的使用体验。 API设计的输入参数开发者要易于获取,输出参数要让开发者易于理解。降低开发者使用API的使用成本,提升API使用体验。避免API的输入参数要通过多次前置条件API的查询获得。 父主题: API生产
本条规则是Should类型的扩展规则,可方便管理API的生命周期。 在进行新版本API设计时应当考虑老版本升级迁移计划,从而实现API的迁移。新版本中继承的接口在语义上应当能兼容老版本。 对于计划不再支持的接口,需要正式发布接口变更公告,应当至少提前6个月在文档标识(使用@depr
创建策略 通过策略的方式,为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网关代理
只允许授权的访问。 签名密钥:API网关代理提供签名密钥,用于后端服务校验API网关代理是否合法。 访问控制 流量控制:API网关代理支持从用户、IP、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。 访问控制:API网关代理支持通过设置IP地址或账户的黑白名单来禁
为什么要申请入驻服务商? 申请入驻API中心服务商有哪些入口? 服务商入驻审核多久通过? 服务商入驻成功后可以取消入驻吗? 服务商入驻成功后信息还可以修改吗? API网关代理 是否必须使用API中心的网关代理功能? 哪些API支持在线调测? 如何获取API调用凭据? API售卖与技术支持
请求资源的内容特性无法满足请求头中的条件。 413 Payload Too Large 请求提交的实体数据大小超过了服务器够处理的范围。 414 URI Too Long 请求的URI长度超过了服务器能够解释的长度。 415 Unsupported Media Type 当前请求的方法和所请求的资源,请求
I接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已搭建完成后端服务。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击待调试的API名称,进入“API运行”页面。
后端服务地址:后端服务的地址。 路径:后端服务的路径。 后端超时 后端服务请求的超时时间。此处默认“5000”ms。 在“返回结果基础定义”页面,定义返回结果。 表5 定义返回结果 信息项 描述 成功响应示例 成功调用API时,返回的响应信息示例。 失败响应示例 调用API失败时,返回的响应信息示例。
State Transfer,表征状态转移)网络上的所有事物都可被抽象为资源,每一个资源都有唯一的资源标识(resource identifier),对资源的操作不会改变这些标识,所有的操作都是无状态的,使用标准方法操作资源。 RESTful风格的服务接口需定义:操作名、URL、请求和响应消息体和响应状态码。