检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
单击“API运行”页签。 根据下表相关任务,了解如何管理API。 表1 管理API 相关任务 使用场景 操作步骤 编辑API 修改API信息。 选择需要编辑的API。 单击“编辑”,修改API信息,具体操作请参考创建API。 授权API 仅使用APP认证方式的API,才需要授权,发布A
通过Explorer调试API “Explorer”功能支持可视化调试和查看API文档。API产品上架到API目录后,消费者可通过“Explorer”功能在线调试API。如果通过APP认证来调用API,那么产品需要先订阅才能选择凭证调用API。 前提条件 应用关联的实例已开启公网访问并配置弹性IP,可参考实例配置参数。
提供多种复杂API的定义样例。 单击“确定”,跳转到API设计文件的“编辑器”页面。 页面左侧为API列表,可选择API或数据模型查看。 页面中间为API的编辑窗口,编辑API时应遵循Swagger 2.0规范定义。 页面右侧为API的可视化视图窗口。 在编辑API设计文件时,单个API最多支持写入102
力。 表1 产品功能 功能 说明 API可视化设计 ROMA API集成了标准的Swagger编辑器,支持编辑器编辑和表单编辑两种方式,并提供规范性检查功能,使用户可以快速、高效的在线进行API Swagger文档的设计。 API快速实现 ROMA API支持通过导入API文档一键生成代码仓以及流水线,降低开发时间。
相关任务 使用场景 操作步骤 查看自定义认证 查看自定义认证详情。 单击认证名称,查看自定义认证详情。 编辑自定义认证 修改自定义认证信息。 找到需要编辑的自定义认证,单击所在行的“编辑”,即可修改自定义认证信息。 删除自定义认证 删除不需要的自定义认证。 找到需要删除的自定义认证,单
在当前应用关联的实例中,根据实际业务选择实例。 根据下表相关任务,了解如何管理策略。 表1 管理策略 相关任务 使用场景 操作步骤 编辑策略 修改策略信息。 选择需要编辑的策略,或单击策略名称,进入策略详情。 单击“编辑”,修改策略信息,具体操作请参考创建API策略。 删除策略 删除不再使用的策略。 单击策略名称,进入策略详情。
“查看”。 管理:自己创建的规则集支持查看和编辑。 查看:其他用户创建的规则集仅支持查看。 通过“问题级别”和“规则类型”选择性查看。 单击规则名称,可查看规则的“正确示例”和“错误示例”。 (可选)编辑规则集,可单击“管理”或“编辑”。 管理:配置规则。 取消已启用规则 在“已
单击“浏览代码”,查看代码库。代码仓库是代码托管服务存储代码的云端仓库。 单击“在线开发”,通过云端开发环境CloudIDE开发代码,请参考在线开发。 单击“克隆/下载”,克隆或下载代码。 在线开发 单击“在线开发”页签。或在“代码仓”区域,单击“在线开发”。 通过IDE左侧的资源管理器可以看到后端代码的结构,如下所示。
在页面中单击API设计文件名称,进入API编辑页面。 单击“编辑器/表单”页签。 单击,导入文件。 导出 API设计文件以YAML或JSON格式导出到本地,用于导入API设计或其他用途。 在页面中单击API设计文件名称,进入API编辑页面。 单击“编辑器/表单”页签。 根据需要导出文件的
在当前应用关联的实例中,根据实际业务选择实例,查看当前实例下包含的API,以及API基本信息。 单击API名称,查看API详情。 支持批量发布、下线、删除API。 单个支持编辑、调试、授权等操作,可参见APIs管理。 父主题: API管理
产品优势 全自动化设计规范检测 从设计者体验和效率出发,提供一款便捷的API编辑器,支持标准Swagger的编辑能力和通俗易懂的表单编辑能力,并融入华为10年累积的API治理规范标准,实现全自动化检测,提升企业API设计的规范性。 自动化代码和用例生成 通过标准Yaml契约,自动
中级使用者入门指导 作为中级使用者,在线设计API文件和上架API目录,需要完成以下流程: 图1 中级使用者流程图 步骤一:购买实例 在创建应用前,需要先购买实例。 步骤二:创建应用 应用是一个系统资源的集合,下面可以划分不同的服务。 步骤三:创建API设计 快速在线设计标准的RESTful
其他方式创建API设计文档,请参考《用户指南》。 将设计文档封装成API服务。 在“编辑器”页面,单击“导入到API服务”,规则检查通过后,继续导入。 在“导入API设计文件”页面,选择实例并编辑服务名称。 进入“全局配置(可选)”页面,并发布。 将API服务生成产品。 在“API运行”页面,单击“生成产品”。
在新建版本中,单击“添加API”,可添加API接口。 编辑 修改产品基本信息。 在API产品所在行,单击“编辑”。 修改产品信息后,单击“完成编辑”。 如果产品已上架,那么需要提交修改申请。 填写申请描述后,单击“确定”。 审核申请通过后,产品信息编辑成功。 删除 API产品不再提供服务,且产品已下架,可以将API产品删除。
当今企业随着系统内部功能逐渐增多,子系统数量成倍增长,各个系统间调用依赖愈发重要,此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器,通过规范化、标准化的API文档形成稳定资产,快速完成内部系统对外接口的统一,有效降低开发成本。 实现API的内部市场 ROMA API
配置参数 实例创建完成后,可在控制台编辑实例的配置信息。 前提条件 已购买实例。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。 单击实例名称或实例卡片右上角的“查看控制台”。
操作步骤 查看证书 查看证书详情。 单击证书名称,查看证书详情。包括序列号、有效期、签名算法、域名等信息。 编辑证书 修改证书信息。 找到需要编辑的证书,单击所在行的“编辑”,即可修改证书信息。 删除证书 删除不需要的证书。 找到需要删除的证书,单击所在行的“删除”,即可删除证书。
通过设置权限管理,把应用下的资源共享给同一账号下的其他IAM用户来查看和使用。 具体操作请参考应用授权。 编辑应用 支持编辑或修改应用名称和描述。 在搜索框中输入需要编辑的应用名称。 单击对应应用所在行的“编辑”,即可编辑应用信息。 删除应用 已创建的应用不再提供服务,可以将应用删除。 在搜索框中输入需要删除的应用名称。
在“凭证信息”区域,凭证“Key”和“Secret”是创建凭证后自动生成的,如需修改密码,单击“重置Secret”重置即可。注意重置后无法恢复,请谨慎操作。 编辑凭证 如需修改凭证信息,单击“编辑凭证”即可。 删除凭证 如需删除凭证信息,单击“删除凭证”即可。 取消订阅 单击“取消订阅”,取消通过该凭证订阅的API产品。
单击“日志分析”页签,查看调用日志信息。 编辑实例 支持编辑实例的基本信息、参数、通道和环境。 找到需要编辑的实例,单击实例名称或实例卡片右上角的“查看控制台”。 单击“实例信息”页签,然后单击可编辑对应参数信息。 单击“配置参数”页签,然后单击对应参数所在行的“编辑”,即可编辑参数信息。 单击“负载