检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
您可以进行以下操作: 规则集管理 启用规则集 根据业务需求选择适用于API设计文件规范性检查的规则集。 创建规则集 根据业务需求创建规则集。 设置无需检查的接口 设置无需规范性检查的接口。 配置扩展字段 支持统一自定义扩展字段,指定显示区域,字段名必须以“x-”开头。 启用规则集 登录ROMA
ttpRequest请求,从而实现跨域访问。更多跨域访问的说明请参考开启跨域共享。 跨域资源共享策略为跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的扩展能力,可快速、灵活的实现API的跨域访问。 使用限制 已了解前提条件。 同一API服务下,相同请求路径的所有API,只能绑定同一个跨域资源共享策略。
打开”。 参考下表配置后端。 表1 后端配置参数说明 参数 参数说明 后端名称 后端的名称。 归属项目 自动读取当前应用已关联Devcloud服务中的项目。 新建代码仓 设置后端代码保存的代码仓库名称,请不要跟该项目下已有代码仓库重名。 新建流水线 选择使用的流水线,当前仅支持在
选择健康检查所使用的HTTP请求方法,可选择“GET”和“HEAD”。 高级设置 检查端口 健康检查的目标端口,默认使用负载通道配置的端口号,但您可以指定其他的端口。 正常阈值 执行健康检查时,判定服务器状态正常的连续检查成功次数。例如“正常阈值”设置为“2”,则在连续2次检查成功时,判定服务器的状态正常。
配置跨域访问API 出于安全性考虑,浏览器会限制从页面脚本内发起的跨域请求,此时页面只能访问当前域的资源。CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。 浏览器将CORS请求分为两类 简单请求 非简单请求 详情请参考配置跨域访问API。 父主题:
单击用例名称,进入“功能手工测试”页面。 单击“接口自动化”页签,可查看或编辑已创建的测试用例。 单击用例名称,进入“测试详情”页面。 单击“测试脚本”页签。 将鼠标移至测试步骤区域,单击展开。 编辑测试步骤,填写请求信息、请求头和请求体。 如果URL中存在调试域名(创建API服务时,自动生成),请将调试域名更
产品优势 全自动化设计规范检测 从设计者体验和效率出发,提供一款便捷的API编辑器,支持标准Swagger的编辑能力和通俗易懂的表单编辑能力,并融入华为10年累积的API治理规范标准,实现全自动化检测,提升企业API设计的规范性。 自动化代码和用例生成 通过标准Yaml契约,自动生成A
含此参数时,ROMA API自动增加默认值发送给后端服务。 字节限制 最大长度/最大值:“类型”为“STRING”时,设置参数值的最大字符串长度,“类型”为“NUMBER”时,设置参数值的最大值。 最小长度/最小值:“类型”为“STRING”时,设置参数值的最小字符串长度,“类型
负载通道(可选) 仅在使用负载通道时,需要设置。选择已创建的负载通道名称。 说明: VPC通道中,云服务器的安全组必须允许100.125.0.0/16网段访问,否则将导致健康检查失败及业务不通。 后端服务地址(可选) 仅在不使用负载通道时,需要设置。 格式:“主机:端口”,主机为IP地
跨域资源共享 浏览器出于安全性考虑,会限制从页面脚本内发起的跨域访问(CORS)请求,此时页面只能访问同源的资源,而CORS允许浏览器向跨域服务器,发送XMLHttpRequest请求,从而实现跨域访问。 前提条件 API已发布。 配置跨域访问控制 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
Token认证 操作场景 当您使用Token认证方式调用API时,需要获取用户Token并在调用API时将Token值设置到调用请求的“X-Auth-Token”头域中。 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证调用请求。 AK/SK认证:通过AK(Access
基础版”。 时间窗 选择技术支持对实例进行维护的时间段,建议选择业务量较少的时间段,保持默认设置“22:00:00---02:00:00”。 企业项目 选择实例所属的企业项目,保持默认设置“default”。 公网入口 为简单起见,此处不开启。 公网出口 为简单起见,此处不开启。
企业联邦用户不能创建访问密钥,但可以创建临时访问凭证(临时AK/SK和SecuritityToken),具体内容请参见:临时访问密钥。 如果您是IAM用户,请在“安全设置>敏感操作>访问密钥保护”确认所属账号是否开启访问密钥保护。 访问密钥保护关闭时,所有IAM用户可以管理(包含创建、启用/停用或删除)自己的访问密钥。
关联项目资源,单击,选择项目。 单击“创建”。 应用创建完成后,您可以在页面左上角“ROMA API”下切换待操作的应用。 首次创建应用后,页面自动跳转到“API设计”,可根据业务需求自行创建设计文件。 应用授权 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。
Cloud Server)是一种可随时自动获取、计算能力可弹性伸缩的云服务器。 产品介绍 什么是ECS 创建容器应用基本流程 如果title超长,将自动截断并显示省略号,若需鼠标经过时冒泡,请在样式中增加 js-title 如果title超长,将自动截断(文字超长时,列表项样式改为:
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏单击“API设计”。 单击“创建API文件”。 在弹窗中修改“名称”,或默认系统自动生成的名称;根据下表说明,选择模板。 表1 API文件模板 模板类型 类型说明 SimpleAPI 提供简单GET请求样例。 DescriptionWithGFM
跨域资源共享:为API的跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的能力。 HTTP响应头管理策略:可以自定义HTTP响应头,在返回的API响应中指定配置的响应头。 可见范围 当实例为ROMA类型时,支持设置当前应用可见或全局应用可见。 描述 填写策略的描述信息。
凭据策略用于API运行时的策略管理,支持配置APPCode、绑定凭据配额策略和绑定访问控制策略,且只有管理员(IAM用户拥有“Tenant Administrator”权限)能设置。 凭据策略分三种类型:集成凭据、订阅凭据和客户凭据(集成凭据由ROMA实例下的集成应用同步创建;订阅凭据通过订阅产品后,在产品所属实例下
支持区域:华北-北京一、华北-北京四、华东-上海一、华东-上海二、华南-广州、乌兰察布二零二 创建API设计 管理规则集 OBS 2.0支持API实现 提供一站式创建代码仓、自动生成框架代码、创建编译构建等流水线任务能力,使后端开发无需从零开始。 支持区域:华北-北京一、华北-北京四、华东-上海一、华东-上海二、华南-广州、乌兰察布二零二
页面的最左侧展示产品下的API,中间可配置API请求参数,最右侧支持查看调试结果和API文档。 (可选)单击“文档”页签,查看API文档信息。 根据已设置认证方式,编辑请求参数,单击“调试”。 表1 请求参数说明 认证方式 Headers Parameters Body APP认证 说明: