检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
从设计者体验和效率出发,提供一款便捷的API编辑器,支持标准Swagger的编辑能力和通俗易懂的表单编辑能力,并融入华为10年累积的API治理规范标准,实现全自动化检测,提升企业API设计的规范性。 自动化代码和用例生成 通过标准Yaml契约,自动生成API框架代码和测试用例,依托CICD(Continuous
规范查询字符串需要满足以下要求: 根据以下规则对每个参数名和值进行URI编码: 请勿对RFC 3986定义的任何非预留字符进行URI编码,这些字符包括:A-Z、a-z、0-9、-、_、.和~。 使用%XY对所有非预留字符进行百分比编码,其中X和Y为十六进制字符(0-9和A-F)。例如,空格字符必须编码为
pt SDK生成curl命令,然后将curl命令复制到命令行调用API。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 调用API示例 使用JavaScript SDK生成curl命令。 下载JavaScript
API的全生命周期管理在应用中实现,应用是一个系统资源的集合,即多个区域下,多个实例和多个项目等资源的集合。 API设计 API设计提供API文档的标准化设计和变更管控。 API实现 API实现是API开发者在后端开发、部署和业务编排的能力。 API管理 API管理提供了API服务开放、配置运行策略、API安全配置等能力。
API开放API,设计API、生成产品并上架到API目录,部门B通过API目录查看和订阅API。此时,部门A通过开放业务能力,使自身服务能力变现,部门B直接订阅部门A开放的API,减少开发时间和成本,实现部门之间业务共享。 前提条件 已创建应用和实例。 开放API A部门将自己的业务变现。 将A部门的业务生成设计文档。
在左侧导航栏选择“API消费 > API产品”。 单击“创建API产品”。 根据参数提示,填写产品基本信息。 在“添加版本和API”区域,选择是否创建产品版本,版本号、实例和API服务,勾选API。 只有已部署到RELEASE环境中的API,才能被添加到API产品中。 每个API仅能被添
在当前应用关联的实例中,根据实际业务选择实例。 在需要生成产品的API服务所在行单击“生成产品”。 填写产品基本信息。 在“添加版本和API”区域,选择是否创建产品版本,版本号、实例和API服务,勾选API。 只有已部署到RELEASE环境中的API,才能被添加到API产品中。 每个API仅能被添
API指标分析 云监控对ROMA API的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API服务和API。 查看单个API的监控指标 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API分析
签名密钥 签名密钥用于后端服务验证API的身份,在API请求后端服务时,保障后端服务的安全。 签名密钥是由一对Key和Secret组成,当签名密钥创建后,ROMA API向后端服务发送此API的请求时,会增加相应的签名信息,此时需要后端服务依照同样方式进行签名,通过比对签名结果与
射关系,将已有的独立域名绑定到API服务上。当客户端发送请求时,根据HTTP请求中的域名定位到所属的API服务,再通过HTTPMethod和PATH确定唯一的API。 在绑定域名前,您需要了解以下2个概念: 调试域名:API服务创建后,系统为服务自动分配一个内部测试用的调试域名,
A API提供了规范化的产品和工具支撑,解决企业发展过程中各阶段遇到的问题,帮助企业快速实现API经济,持续构建高质量的API服务能力。 表1 产品功能 功能 说明 API可视化设计 ROMA API集成了标准的Swagger编辑器,支持编辑器编辑和表单编辑两种方式,并提供规范性
绑定独立域名后,还需为独立域名添加SSL证书。 前提条件 仅支持添加pem编码格式的SSL证书。 添加的SSL证书仅支持RSA、ECDSA和DSA加密算法。 创建SSL证书 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理
本手册主要介绍以API设计者、API开发者、API管理者和API消费者角色和流程来定义API的生命周期,包含了API设计、API实现、API管理、API消费和API分析五大流程。API资产从Swagger文档、后端能力、API服务和API产品在流程中轮转,并不断演进。 应用是一个系统
删除API设计文件。 单击对应API设计文件所在行的“删除”,即可删除。 API变更历史 API设计文件的变更记录。支持查看变更前后的内容和还原变更内容。 查看全局API设计文件的变更历史 在页面右上角单击“API变更历史”,进入变更列表页面。 通过变更时间、请求方式或URL筛选变更信息。
2018.3.5版本、搭建Node.js环境为例。浏览器等,只提供代码示例说明。 准备环境 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 获取并安装Nodejs安装包,如果未安装,请至Nodejs官方下载页面下载。 获取并安装IntelliJ
创建自定义认证 自定义认证包含两种认证:前端自定义认证和后端自定义认证。 前端自定义认证:如果您希望使用自己的认证系统,而不是APP认证/华为IAM认证对API的访问进行认证鉴权时,您可以使用自定义认证,通过您自定义的函数进行认证鉴权。 后端自定义认证:当不同的后端服务使用不同的
超过此限制将无法保存设计文件。 完成编辑后,单击右上角的“保存”。 您还可以执行以下操作。 (可选)配置SLA,提前设计接口运行的可靠性和性能指标。 (可选)Mock调测,对接口地址进行调测。 (可选)规范性检查,对接口规范性检查。 (可选)导入到API服务,将已设计的接口导入API服务。
功能模块 功能描述 相关文档 1 API设计 支持API整体的规划和设计,提供Mock调测和规范性检查。 API设计 2 API管理 支持API服务和API策略能力,提供API服务定义和策略管理。 支持API创建、调试和发布功能。 API管理 3 API消费 支持从服务中挑选的部分A
支持Token认证和AK/SK认证两种。 Token认证:通过Token认证调用请求。Token认证无需使用SDK签名,优先使用Token认证。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)认证调用请求。其签名方式和APP认证相似。
权应用的Key和Secret(或客户端的AppKey和AppSecret),以及用于调用API的SDK。 简易认证:向API管理者获取该API所在应用的AppCode。 其他认证:向API管理者获取该API所授权应用的Key和Secret(或客户端的AppKey和AppSecret)或凭证信息。