检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已搭建完成后端服务。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理
代理也仅校验AppCode,不校验请求签名,从而实现快速响应。 注意仅支持HTTPS方式调用,不支持HTTP方式。具体使用请参考为简易认证绑定AppCode。 说明: 如果首次创建API未开启简易认证,那么之后开启简易认证,需要重新发布API。请参考发布API发布。 支持跨域CORS
除或者导出API分组。 步骤2:绑定域名 在左侧导航栏选择“API网关代理 > API分组”。 在“API分组”页面,单击分组名称,进入分组详情页面。 单击“分组信息”页签。 在“域名管理”区域,单击“绑定独立域名”,填写要绑定的域名。 图1 绑定独立域名 填写的独立域名必须已备
下的API。 后续操作 创建API分组成功后,您还可以执行如表3的操作。 表3 后续操作 操作 说明 为API分组绑定独立域名 在开放API前,您需要为API分组绑定独立域名,API调用者通过独立域名访问分组内的API。 添加环境变量 通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。
ger扩展字段。 全量定义:导出API前端定义和后端定义。 扩展定义:导出API前端定义、后端定义、API关联的流量控制、访问控制等策略及绑定关系。 导出格式 选择JSON或YAML。 自定义版本 为导出的API自定义版本号,如果没有指定版本号,默认使用当前时间。 单击“导出”,右侧显示导出结果,并自动下载文件。
中获取的请求方法。 {Address}:请求地址,需替换为获取API的请求信息中获取的域名地址。 API网关代理使用分组分配的子域名或分组绑定的域名调用API,无需另外配置。 {Path}:请求路径,需替换为获取API的请求信息中获取的URL。 {Query}:查询参数,可选,格
响应消息头 调用API时,API网关代理增加如下响应消息头。 X-Apig-Mode: debug表示响应消息头增加API网关代理调试信息。 响应消息头 描述 说明 X-Request-Id 请求ID 所有合法请求,都会返回此参数 X-Apig-Latency 从API网关代理接收请求到后端返回消息头的用时
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则,可保障API的可维护性。 在采集API调用日志过程中,需要保证API日志的实时性和完整性,以提升API分析的精准度。 API日志在传递过程中,必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
术语 API API(Application Programming Interface,应用程序接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。 API Gateway API Gateway(Application
易用性 API名称必须易于理解、见名知义 本条规则是Should类型的扩展规则,可提升API调用者的使用体验。 API名称要简洁、易于理解、见名知义,建议按照“动词+名词”格式。 在生产环境的API不能包含“test、uat、sit、beta”等字样,API名称只支持中文、字母、
开启跨域访问 什么是跨域访问 浏览器出于安全性考虑,会限制从页面脚本内发起的跨域访问(CORS)请求,此时页面只能访问同源的资源。而CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。 图1 跨域访问 浏览器将CORS请求分为两类: 简单请求 简单跨域请求的场景需要满足以下两个条件:
可用性 API请求URI中如果存在特殊字符,需要进行转义编码 本条规则是MUST类型的基本规则,可保障API的高可用性。 某些字符,由于有特殊含义或者系统保留,容易被Web应用防火墙或者安全访问控制产品所阻断,导致URI调用不生效,因此不建议在URI中使用,如果必须要用需要用转义编码替换。