检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
添加多个后端策略后,通过不同的策略条件,请求被转发到不同的后端服务中。 单击添加策略后端。 后端策略增加的参数,具体如表9所示,其他参数说明参考表4、表5和表6。 表9 后端策略参数 信息项 描述 后端策略名称 您自定义的名称,用于识别不同的后端策略。 生效方式 满足任一条件:只要
表1 定义扩展字段 信息项 描述 Key 填写Key值。 显示名 填写扩展字段名称。 显示样式 填写扩展字段的值,支持文本框、单选框、复选框和下拉列表的形式。 配置值 填写扩展字段的值,显示样式非“文本框”时,配置值必填。 必填 若勾选,表示配置扩展字段时,扩展字段内容不能为空。 显示区域
中各阶段遇到的问题,帮助企业快速实现API经济,持续构建高质量的API服务能力。 表1 产品功能 功能 说明 API可视化设计 ROMA API集成了标准的Swagger编辑器,支持编辑器编辑和表单编辑两种方式,并提供规范性检查功能,使用户可以快速、高效的在线进行API Swagger文档的设计。
快速入门 OBS 2.0支持虚拟私有云子功能二 虚拟私有云(Virtual Private Cloud,以下简称VPC),为云服务器、云容器、云数据库等资源构建隔离的、用户自主配置和管理的虚拟网络环境,提升用户云上资源的安全性,简化用户的网络部署。 您可以在VPC中定义安全组、VPN、
API定义范围 选择导出的API服务文件中,API定义字段的类型范围。 基础定义:包括API前端请求定义和响应定义,不包括后端服务定义。其中API前端请求定义除了Swagger规范定义项外,还包括APIC的一些Swagger扩展字段。 全量定义:包括API前端请求定义、后端服务定义和响应定义。
单击实例名称或实例卡片右上角的“查看控制台”。 单击“配置参数”页签。 在“配置参数”页面,找到需要配置的参数,单击“编辑”。 根据下表参数说明,配置参数。 表1 配置参数说明 内容 内容说明 参数 参数的名称。查看参数的具体功能说明,请参考实例配置参数说明。 参数默认值 参数的系统默认值。
return wrapped return wrapper wrapped函数为签名校验代码。校验流程如下:使用正则表达式解析Authorization头。得到key和signedHeaders。 1 2 3 4 5 6 7 8 if "authorization"
“日志组”和“日志流”设置完成后,单击“确定”。 查看日志分析可单击“日志字段说明”,根据日志字段说明分析日志。 访问日志的字段采用空格作为分隔符,按照顺序,每个字段的含义如下: 表1 日志字段说明 序号 字段 说明 1 remote_addr 客户端地址 2 request_id
在“API接口”列表中勾选要开放的API,单击“立即导入”。 (可选)单击“全局配置(可选)”。 安全配置。 表1 安全配置参数说明 参数 参数说明 安全认证 API使用的认证方式,推荐使用APP认证。 APP认证:表示由ROMA API进行API请求的安全认证。 华为IAM认证:表示通过IAM服务进行安全认证。
审批申请 查看上架是否成功。 返回产品详情页面,查看版本是否上架成功。 图3 上架成功 查看API产品 B部门在“目录列表”中查看API产品。 订阅API B部门在“目录列表”中订阅API产品。 单击“订阅”,填写订阅申请信息。 图4 订阅申请 在“审核管理”页面,选择“我提交的申请”页签,可查看申请详情。
与“API流量限制”配合使用,表示单位时间内的单个API请求次数上限。 与“用户流量限制”配合使用,表示单位时间内的单个用户请求次数上限。 与“应用流量限制”配合使用,表示单位时间内的单个APP请求次数上限。 API流量限制 单个API被调用次数上限。 与“时长”配合使用,表示单位时间内的单个API请求次数上限。
Finish”,完成工程导入。 在右侧Maven页签,双击“compile”进行编译。 图2 编译工程 返回“BUILD SUCCESS”,表示编译成功。 右键单击BackendSignatureApplication,选择“Run”运行服务。 图3 运行服务 “ApigatewaySignatureFilter
在当前应用关联的实例中,根据实际业务选择实例。 单击“自定义认证”页签。 在自定义认证页面,单击“创建自定义认证”。 在创建自定义认证弹框中,根据下表填写参数信息。 表1 自定义认证参数 信息项 描述 认证名称 您自定义的认证名称,用于区分不同的自定义认证。 类型 前端:对API的访问进行认证鉴权。
导入API设计文件,从“API设计”中选择设计文件导入,单击“确定”。 导入Swagger文件,从本地导入文件,单击“打开”。 参考下表配置后端。 表1 后端配置参数说明 参数 参数说明 后端名称 后端的名称。 归属项目 自动读取当前应用已关联Devcloud服务中的项目。 新建代码仓
配置参数说明 表1 配置参数说明 参数 配置说明 allowed origins Access-Control-Allow-Origin响应头,指定允许访问API的外域URI,多个URI之间使用英文逗号隔开。 对于未携带身份凭证的请求,可以把参数值设置为“*”,表示允许来自所有域的访问请求。
及响应内容。 响应内容的错误信息以及其他信息,可通过变量的方式获取,支持的变量见表2。 网关错误响应类型说明 ROMA API提供的错误响应类型见表1,其中响应状态码可以按实际需要做自定义修改。 表1 ROMA API的错误响应类型 错误响应类型 默认的响应状态码 错误说明 详细说明
... } } } OnAuthorization函数为签名校验代码。校验流程如下:使用正则表达式解析Authorization头。得到key和signedHeaders。 1 2 3 4 5 6 7 8 9 10 11
在“访问控制策略”区域,单击“绑定访问控制策略”。 在弹窗中配置策略信息。 表3 配置访问控制策略 参数 配置说明 动作 选择访问控制的动作。 允许:表示仅允许指定IP地址的客户端调用API。 禁止:表示禁止指定IP地址的客户端调用API。 IP地址 单击“增加IP地址”,添加允
return "Hello, Devstar!"; } } 添加的代码中: @RestController表明这个类是可以处理请求的控制器类。 @GetMapping("/")表明使用hello()方法来应答由http://localhost:8080/发出的请求。 编译执行代码,验证结果。
产品优势 全自动化设计规范检测 从设计者体验和效率出发,提供一款便捷的API编辑器,支持标准Swagger的编辑能力和通俗易懂的表单编辑能力,并融入华为10年累积的API治理规范标准,实现全自动化检测,提升企业API设计的规范性。 自动化代码和用例生成 通过标准Yaml契约,自动