检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在API设计和变更阶段指导设计者遵从API格式规范,提升企业API的交付质量。
以API流程规范解决企业业务发展过程中遇到的各阶段问题,提供了规范化的产品跟工具支撑,帮助企业快速实现API经济,并持续构建高质量的API服务能力。
API设计配置 ROMA API提供了API设计文件规范性检查,帮助用户快速设计标准的RESTful API。您可以选择已有的规则集或者新建规则集对API设计文件进行规范性检查。
产品优势 全自动化设计规范检测 从设计者体验和效率出发,提供一款便捷的API编辑器,支持标准Swagger的编辑能力和通俗易懂的表单编辑能力,并融入华为10年累积的API治理规范标准,实现全自动化检测,提升企业API设计的规范性。
步骤1:构造规范请求 使用APP方式进行签名与认证,首先需要规范请求内容,然后再进行签名。客户端与API网关使用相同的请求规范,可以确保同一个HTTP请求的前后端得到相同的签名结果,从而完成身份校验。
重命名 修改API设计文件名称。 单击对应API设计文件所在行的“重命名”,即可修改名称。 删除 删除API设计文件。 单击对应API设计文件所在行的“删除”,即可删除。 API变更历史 API设计文件的变更记录。支持查看变更前后的内容和还原变更内容。
ROMA API提供了规范化的产品和工具支撑,解决企业发展过程中各阶段遇到的问题,帮助企业快速实现API经济,持续构建高质量的API服务能力。
(可选)规范性检查。 在规范性检查之前,您需提前启用规则集或创建规则集。在编辑窗口上方单击“规范性检查”,检查结果在可视化视图窗口查看,您可以根据修改建议修改规范性问题。 图1 规范性检查结果 (可选)导入到API服务。
ROMA API提供可视化的API文档编辑器,通过规范化、标准化的API文档形成稳定资产,快速完成内部系统对外接口的统一,有效降低开发成本。
建议您按照一定的命名规则填写负载通道名称,方便您快速识别和查找。 端口 填写负载通道的服务器访问端口号。 分发算法 选择后端服务请求的分发算法,负载通道通过分发算法确定请求被发送到哪台服务器上。
编辑API,并单击“规范性检查”,按照“Compliance”提示修改内容。 图4 创建API设计 单击“保存”。 步骤四:后端开发(可选) 在左侧导航栏选择“API实现 > 后端开发”。 单击“创建后端”,选择“导入API设计”。 选择API设计文件,单击“确定”。
建议您按照一定的命名规则填写SSL证书名称,方便您快速识别和查找。 证书内容 填写pem编码格式的SSL证书内容。 以文本方式打开待添加证书里的PEM格式证书文件(后缀名为“.pem”),将证书内容复制到“证书内容”中即可。
其中API前端请求定义除了Swagger规范定义项外,还包括APIC的一些Swagger扩展字段。 全量定义:包括API前端请求定义、后端服务定义和响应定义。 扩展定义:包括API前端请求定义、后端服务定义和响应定义,还包括API关联的流量控制、访问控制等策略对象的定义。
API测试 2021年3月 序号 功能模块 功能描述 相关文档 1 API设计 支持API整体的规划和设计,提供Mock调测和规范性检查。 API设计 2 API管理 支持API服务和API策略能力,提供API服务定义和策略管理。 支持API创建、调试和发布功能。
建议您按照一定的命名规则填写策略名称,方便您快速识别和查找。 策略类型 选择策略的类型,不同类型的策略提供不同扩展能力。 跨域资源共享:为API的跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的能力。
成长地图 | 华为云 API全生命周期管理 API全生命周期(ROMA API)提供API设计、API实现、API管理、API消费、API分析能力,端到端从源头到资产实现企业规范化管理,帮助企业快速实现API经济,并持续构建高质量的API服务能力。
allowed methods Access-Control-Allow-Methods响应头,指定允许使用的HTTP请求方法,多个请求方法之间使用英文逗号隔开。
建议您按照一定的命名规则填写配额策略名称,方便您快速识别和查找。 首次生效时间点 设置配额策略的生效起始时间点。
“条件类型”为“枚举”时,输入多个值,以英文逗号隔开。 “条件类型”为“匹配”时,输入一个范围,例如:[0-5]。 “条件来源”为“源地址”时,输入一个或多个IP地址,以英文逗号隔开。 单击“完成”,进入“API运行”页面,可查看API信息。
支持输入多个账户名,以英文“,”隔开,如aaa,bbb。 说明: 仅支持IAM账号维度的访问控制,不能对单个IAM用户进行访问控制。 单击“确定”,完成访问控制策略的创建。 获取账号名 登录管理控制台。 获取账号名。 将鼠标移至用户名,在下拉列表中单击“我的凭证”。