检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API”下选择待操作的应用。 在左侧导航栏单击“API设计”。 在页面右上角单击“API设计配置”。 单击“无需检查的接口”页签。 单击“添加API”,选择对应API设计文件下不需要规范性检查的API。 单击“保存”,设置完成。 如需取消,单击“移除”,或选择API后,单击“批量移除”。
"Action=ListUsers&Version=2010-05-08", "demo"); 给请求添加x-stage头,内容为环境名。如果有需要,添加需要签名的其他头域。 request->addHeader("x-stage", "RELEASE"); 进行签名
编辑测试步骤,填写请求信息、请求头和请求体。 如果URL中存在调试域名(创建API服务时,自动生成),请将调试域名更改为实例的弹性IP地址,并且header中需添加参数host,值为调试域名。 单击执行测试。 若执行失败,可单击“查看结果”,查看日志定位原因。 更多详细操作,请参考快速入门。 父主题:
params.query_str = query_str; params.payload = payload; 给请求添加x-stage头,内容为环境名。如果有需要,添加需要签名的其他头域。 sig_headers_add(¶ms.headers, "x-stage", "RELEASE");
{"x-stage": "RELEASE"}, "body") 进行签名,执行此函数会在请求参数中添加用于签名的X-Sdk-Date头和Authorization头。 X-Sdk-Date是一个必须参与签名的请求消息头参数。 1 sig.Sign(r)
配置网关响应 网关响应指ROMA API未能成功处理API请求,从而产生的错误响应。ROMA API提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API服务管理中新增网关响应,其中响应内容符合JSON格式即可。 例如,“default”网关的响应内容为:
on> </dependency> 使用maven构建时,settings.xml文件需要修改,增加以下内容: 在profiles节点中添加如下内容: <profile> <id>MyProfile</id> <repositories> <repository>
产品优势 全自动化设计规范检测 从设计者体验和效率出发,提供一款便捷的API编辑器,支持标准Swagger的编辑能力和通俗易懂的表单编辑能力,并融入华为10年累积的API治理规范标准,实现全自动化检测,提升企业API设计的规范性。 自动化代码和用例生成 通过标准Yaml契约,自动
curl 操作场景 使用curl命令调用APP认证的API时,您需要先下载JavaScript SDK生成curl命令,然后将curl命令复制到命令行调用API。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 调用API示例
应用场景 企业API文档规范统一 当今企业随着系统内部功能逐渐增多,子系统数量成倍增长,各个系统间调用依赖愈发重要,此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器,通过规范化、标准化的API文档形成稳定资产,快速完成内部系统对外接口的统一,有效降低开发成本。
管理API设计 您可以在创建的API设计文件内,创建多个API,对API进行Tag分类,或者以YAML或JSON格式导出到本地,用于导入API设计或其他用途。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏单击“API设计”。
发布API 在API创建后,您需要把API发布到环境,API只有在发布到环境后,才支持被其他用户调用。 作为初级使用者,成功创建API后,您可以在“API运行”页签通过单个发布或批量发布API。 作为中级使用者,在创建API服务时,您可以把服务部署到环境上,同时间接地发布API。
什么是ROMA API ROMA API是为API提供全生命周期治理的服务,解决API的设计、实现、管理、消费、以及分析等全流程场景的管理问题。ROMA API提供了规范化的产品和工具支撑,解决企业发展过程中各阶段遇到的问题,帮助企业快速实现API经济,持续构建高质量的API服务能力。
企业内部开放API及文档 本章节讲述企业内部如何开放API及文档。企业内部之间通过ROMA API将服务或数据变现,内部之间相互调用实现资源共享。 例如,部门A在ROMA API开放API,设计API、生成产品并上架到API目录,部门B通过API目录查看和订阅API。此时,部门A
创建API设计 ROMA API提供了可视化的API在线设计能力,及接口规范性检查,帮助用户快速设计标准的RESTful API。在开始设计API前,您需要创建一个设计文件。 首次创建API设计支持新建和导入两种方式。 本地无API设计文件可创建API文件。 本地已存在API设计
API设计 创建API设计 API设计配置 管理API设计
自定义认证 创建自定义认证 管理自定义认证 父主题: API管理
API产品 创建API产品 上架目录 管理API产品 父主题: API消费
API分析 API指标分析
实例管理 购买实例 管理实例 配置参数 创建负载通道 创建环境 分析日志 父主题: 管理中心