检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
开箱即用的服务 只需在管理控制台配置,即可快速创建API。提供页面调试工具,简化API开发。可同时发布一个API到多个环境,快速迭代、测试API。 便捷的API生命周期管理 API网关提供全生命周期的API管理,从设计、开发、测试、发布、运维、上架、下架等, 实现完整的API解决方案。帮助
de”。 在弹窗中选择“自动生成”生成方式。 单击“确定”。 调用API。 使用接口测试工具配置API请求和认证信息。 选择请求方法“GET”,在“API运行”页面将URL地址复制到接口测试工具中,URL地址由https://调试域名/路径组成。 添加Header参数名称:X-A
域名是否备案成功,且能正常解析。 域名是否绑定到正确的API分组。 子域名(调试域名)访问超过默认次数。API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名唯一且不可更改,每天最多可以访问1000次。您可以通过添加独立域名来访问您开放的API。 发布问题 API是否已发布。
配置API的发布环境和环境变量(可选) 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建的一种变量,该变量固定在环境上。如果API的后端服
配置API的调用域名 API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名每天最多可以访问1000次。因此,在开放API前,您需要为API分组绑定独立域名,用户通过独立域名访问分组内的API。最多可以添加5个独立域名,不限访问次数。 独立域名可分为内网域名和公网域名两种:
创建API 创建gRPC类型的API,前后端协议均为GRPCS。 发布API 将gRPC类型的API发布到环境上。 验证 使用gRPC客户端测试gRPC服务可用性,如果服务端正常返回响应,则表示gRPC服务可用。 父主题: 使用APIG专享版实现gRPC服务的路由转发
调试API时,默认使用APIG特定的debug环境,因此不能指定其他环境。 调试完成后,需将API发布到对应环境上,再使用代码或者postman等工具,并添加请求消息头X-Stage,才能访问指定环境。 父主题: 发布API
域名部分即可。 选择API的发布环境,并填写发布说明。 单击“确定”,API发布成功后,发布按钮左上角的红色感叹号消失。 验证 使用接口测试工具调用已创建的API,或者在客户端调用已创建的API。 填写API所属分组的调试域名。 导入服务端的proto文件。 此处的proto文件如下:
创建环境和环境变量 操作场景 API可以同时提供给不同的环境调用,如生产、测试或开发。RELEASE是默认存在的环境,无需创建。且API网关提供环境变量功能,通过创建环境变量,实现在不同的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上
在已绑定独立域名所在行单击“选择SSL证书”。 选择已创建的证书单击“确定”。单向认证时,确保客户端认证为关闭状态。 调用API。 使用接口测试工具调用API,状态码为“200”表示调用成功。否则,请参考错误码章节处理。 双向认证 在“SSL证书管理”页签中,单击“创建SSL证书”。
}) } return json.dumps(resp) 配置测试事件并调试代码,然后部署。 在下拉框中选择“配置测试事件”并配置。将以下代码设置为测试事件。测试事件的参数值与环境变量中的参数值需要保持一致。 { "headers": {
0的版本为稳定版本,发布到了生产环境供生产使用,同时,该API正处于迭代中,v1.1的版本是开发人员交付测试人员进行测试的版本,发布在测试环境上,而v1.2的版本目前开发团队正处于开发过程中,可以发布到开发环境进行自测等。 为此,API网关提供多环境管理功能,使租户能够最大化的模拟实际场景,低成本的接入API网关。 URI
0的版本为稳定版本,发布到了生产环境供生产使用,同时,该API正处于迭代中,v1.1的版本是开发人员交付测试人员进行测试的版本,发布在测试环境上,而v1.2的版本目前开发团队正处于开发过程中,可以发布到开发环境进行自测等。 为此,API网关提供多环境管理功能,使租户能够最大化的模拟实际场景,低成本的接入API网关。 URI
0的版本为稳定版本,发布到了生产环境供生产使用,同时,该API正处于迭代中,v1.1的版本是开发人员交付测试人员进行测试的版本,发布在测试环境上,而v1.2的版本目前开发团队正处于开发过程中,可以发布到开发环境进行自测等。 为此,API网关提供多环境管理功能,使租户能够最大化的模拟实际场景,低成本的接入API网关。
} return json.dumps(resp) 测试函数。在测试事件的“事件模板”中选择“apig-event-template”,根据实际情况修改后保存测试模板,单击“测试”。 执行结果为“成功”时,表示测试成功。 接下来您需要进入API网关界面创建前端自定义认证。 创建前端自定义认证
共享版中,不同分组下不能绑定相同的独立域名。 在绑定域名前,您需要理解以下2个概念: 子域名:API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名唯一且不可更改,每天最多可以访问1000次。 独立域名:您自定义的域名,最多可以添加5个独立域名,不限访问次数。API
00ms]。 后端信息配置完成后,单击“完成”。 API创建完成后,在“API运行”页签中,单击“发布最新版本”,发布API。 使用接口测试工具调用API。 本实践通过IP调用DEFAULT分组下的API,输入“wss://IP地址/hello”发送请求即可。其中,IP地址为AP
return json.dumps(resp) 测试函数。在测试事件的“事件模板”中选择“空白模板”,内容为: {"user_data": "123"} 根据实际情况修改后保存测试模板,单击“测试”。 执行结果为“成功”时,表示测试成功。 接下来您需要进入API网关界面创建后端自定义认证。
完成分组信息填写后,单击“确定”,创建API分组。 创建分组成功后,在“API分组”页面的列表中显示新创建的API分组。 API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名每天最多可以访问1000次。 共享版中的API,分组子域名可公网访问。 对外开放API时,您需要为API分组绑定您自己的独立域名。
I。 同一个API发布到不同的环境时,可以为之定义不同的流控策略并授权给不同的应用(凭据)。举例,API v2版本在测试过程中,可以发布到BETA环境,并授权给测试应用(凭据),而API v1版本是稳定版本,可以在RELEASE环境中,授权给所有用户或应用(凭据)使用。 父主题: