检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
谁为API使用者提供技术支持? API中心主要是作为API汇聚和运营API的平台,支撑API开发者和应用开发者更高效便捷的开放和使用API。API相关的技术支持等服务,由API提供方即API服务商负责。 父主题: API售卖与技术支持
可维护性 API需要保持向后兼容性 本条规则是MUST类型的基本规则,可保障API的可维护性。 现网API版本一般保留3个版本或以下,如果超过3个版本会增加API本身的维护量,建议对旧版本API进行下线处理。 服务端API改动必须保证所有的服务消费者不被破坏。API是服务端和客户端的契约
调试API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已搭建完成后端服务。 操作步骤 进入
生产API 使用场景 如果您想要使用API中心提供的工具开发API,请参考本章指导操作。 操作步骤 下面以API Arts工具为例,描述如何开发API并上架API至API中心门户网站。 进入API中心服务页面。 选择左侧导航栏中的“API工具库”。 单击API Arts工具右下角的
哪些API支持在线调测? API中心服务商在上架API资产时,如果提供了符合Swagger 2.0/OpenAPI 3.0规范的API文件,且提供了API资产的访问域名,则该API可以在线调测。 父主题: API网关代理
注册API到网关代理 使用场景 如果您想要将已开发好的API注册到API中心网关,请参考本章指导操作。 前提条件 已完成服务商入驻,具体操作指导参考《用户指南》服务商入驻章节。 使用流程 作为API提供者开放API,您需要先后完成以下流程: 步骤1:创建API分组 进入API中心服务页面
访问控制策略说明 访问控制策略是API网关代理提供的API安全防护组件之一,主要用来控制访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API。 访问控制策略和API本身是相互独立的,只有将访问控制策略绑定API后,访问控制策略才对绑定的
API数据分析 API数据分析页面通过图表的形式,直观地展示您在API网关代理中已经发布的所有API被调用的情况。 前提条件 已成功申请入驻成为API中心服务商。具体操作指导参见服务商入驻。 查看步骤 进入API中心服务页面。 在左侧导航栏选择“API数据分析”。 资源概览区域参数的含义如表
创建API API提供者把API接口配置在API网关代理中,开放后端能力。创建API主要分为两个步骤: 前端配置 支持配置前端定义、安全配置和请求参数。 后端配置 支持配置默认后端、策略后端和返回结果。 API网关代理是基于REST的API架构,API的开放和调用需要遵循RESTful
使用前必读 API中心是为API开发者和应用开发者构建的海量API的汇聚运营平台。帮助API开发者高效便捷的分享和开放API,支持应用开发者快速查找所需API并进行应用开发和集成。本文将详细介绍API中心服务的基本功能以及操作步骤。
开启跨域访问 什么是跨域访问 浏览器出于安全性考虑,会限制从页面脚本内发起的跨域访问(CORS)请求,此时页面只能访问同源的资源。而CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。 图1 跨域访问 浏览器将CORS请求分为两类: 简单请求 简单跨域请求的场景需要满足以下两个条件
API订阅管理 您可以在API中心门户网站中,通过订阅API,获取API资产服务商的联系方式。如果您想要查看您在API中心门户网站中已经订阅的所有API,或对已经订阅的API单个或批量取消订阅,可以参考本章指导操作。 查看已经订阅的所有API:参考查看订阅的所有API。 对已经订阅的
基本概念 API API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,应用将自身的服务能力封装成API,并通过API网关代理开放给用户调用。 API包括基本信息、前后端的请求路径、参数以及请求相关协议。 API分组 API
下线API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API中心服务页面。
环境变量 API网关代理提供环境变量功能,通过创建环境变量,实现在不同的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。 当创建API时定义了变量标识,则需要在环境中添加变量
可用性 API需要配置并发请求及流量控制 本条规则是Should类型的扩展规则,可提升API的可用性。 在API发布之前,需要根据设计的服务等级标准进行流量控制设置。API流量控制包括三个部分:并发请求控制,吞吐量控制和传输流量控制。 并发请求控制:指API最大允许的客户端连接数量
API工具库 该页面展示的是一些开发API的工具。通过这个页面的工具可以开发API,然后通过创建API资产,将开发好的API分享至API中心。 操作步骤 下面以API Arts工具为例,描述如何开发API并上架API至API中心门户网站。 进入API中心服务页面。 选择左侧导航栏中的
可用性 API请求URI中如果存在特殊字符,需要进行转义编码 本条规则是MUST类型的基本规则,可保障API的高可用性。 某些字符,由于有特殊含义或者系统保留,容易被Web应用防火墙或者安全访问控制产品所阻断,导致URI调用不生效,因此不建议在URI中使用,如果必须要用需要用转义编码替换
生命周期管理 API接口变更在参考文档中为新版本提供迁移计划 本条规则是Should类型的扩展规则,可方便管理API的生命周期。 在进行新版本API设计时应当考虑老版本升级迁移计划,从而实现API的迁移。新版本中继承的接口在语义上应当能兼容老版本。 对于计划不再支持的接口,需要正式发布接口变更公告
发布API 创建完成的API,支持发布到不同的环境。API只有在发布到环境后,才支持被调用。API网关代理支持查看API发布历史(如版本、发布说明、发布时间和发布环境),并支持回滚到不同的API历史版本。 已发布的API,在修改信息后,需要重新发布才能将修改后的信息同步到环境中。