检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
中级使用者入门指导 作为中级使用者,在线设计API文件和上架API目录,需要完成以下流程: 图1 中级使用者流程图 步骤一:购买实例 在创建应用前,需要先购买实例。 步骤二:创建应用 应用是一个系统资源的集合,下面可以划分不同的服务。 步骤三:创建API设计 快速在线设计标准的RESTful
插件策略请参考下表配置: 表1 插件策略配置 参数 配置说明 策略名称 填写策略的名称,根据规划自定义。建议您按照一定的命名规则填写策略名称,方便您快速识别和查找。 策略类型 选择策略的类型,不同类型的策略提供不同扩展能力。 跨域资源共享:为API的跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的能力。
SSL证书配置 参数 配置说明 证书名称 填写SSL证书的名称,根据规划自定义。建议您按照一定的命名规则填写SSL证书名称,方便您快速识别和查找。 证书内容 填写pem编码格式的SSL证书内容。 以文本方式打开待添加证书里的PEM格式证书文件(后缀名为“.pem”),将证书内容复制到“证书内容”中即可。
单击实例名称或实例卡片右上角的“查看控制台”。 单击“负载通道”页签。 单击“创建负载通道”。 根据下表参数说明,配置通道信息。 表1 负载通道参数说明 参数类型 参数项 说明 基本信息 通道名称 填写负载通道的名称,根据规划自定义。建议您按照一定的命名规则填写负载通道名称,方便您快速识别和查找。 端口
创建API设计 ROMA API提供了可视化的API在线设计能力,及接口规范性检查,帮助用户快速设计标准的RESTful API。在开始设计API前,您需要创建一个设计文件。 首次创建API设计支持新建和导入两种方式。 本地无API设计文件可创建API文件。 本地已存在API设计
单击“创建”,页面自动跳转到“后端总览”,支持查看后端“基本信息”、“代码仓库”和“流水线”信息。 后端创建完成后,您可以在“代码仓库”中: 单击“浏览代码”,查看代码库。代码仓库是代码托管服务存储代码的云端仓库。 单击“在线开发”,通过云端开发环境CloudIDE开发代码,请参考在线开发。 单击“克隆/下载”,克隆或下载代码。
通过Explorer调试API “Explorer”功能支持可视化调试和查看API文档。API产品上架到API目录后,消费者可通过“Explorer”功能在线调试API。如果通过APP认证来调用API,那么产品需要先订阅才能选择凭证调用API。 前提条件 应用关联的实例已开启公网
配置凭据配额策略 参数 配置说明 策略名称 填写客户端配额策略的名称,根据规划自定义。建议您按照一定的命名规则填写配额策略名称,方便您快速识别和查找。 首次生效时间点 设置配额策略的生效起始时间点。例如,时长为1小时,首次生效时间点为2020/08/08 05:05:00,则表示客户端配额策略从2020/08/08
选择已有策略:单击“选择已有策略”后,选择策略名称。 创建新策略:请参考表1所示输入信息。 表1 密钥信息 信息项 描述 密钥名称 自定义名称,用于识别不同的密钥。 类型 选择签名密钥的认证类型,可选择“APP认证”、“Basic Auth”或“Public Key”。 在应用关联实例的配
API服务提供了便捷式的API资产管理,通过规范化流程帮助企业快速实现资产变现。 丰富的API运营分析 支持详细的API调用分析和告警设置,识别系统可能存在的潜在风险,并借助离线日志分析,完成精细化的运营报表呈现,让您快速洞察API业务演进。
根据下表参数信息,配置前端定义。 表1 前端定义参数 信息项 描述 API名称 API名称,根据规划自定义。建议您按照一定的命名规则填写API名称,方便您快速识别和查找。 URL 前端地址由请求方法、请求协议、子域名和路径组成。 请求方法:GET、POST、DELETE、PUT、PATCH、HEAD、O
ROMA API提供API产品目录以及订阅系统,API的管理者可将API包装成产品上架到API目录中供其他订阅者使用,订阅者可通过查看API的详细文档以及在线调试来自由的选择需要订阅的API产品。
查功能,使用户可以快速、高效的在线进行API Swagger文档的设计。 API快速实现 ROMA API支持通过导入API文档一键生成代码仓以及流水线,降低开发时间。 API管理 包括API的创建、发布、下线和删除的完整生命周期管理,提供便捷的在线调试能力,支持导入Swagge
API设计文件的变更记录。支持查看变更前后的内容和还原变更内容。 查看全局API设计文件的变更历史 在页面右上角单击“API变更历史”,进入变更列表页面。 通过变更时间、请求方式或URL筛选变更信息。 单击“查看详情”,可通过文本形式或表单形式查看变更内容。 查看单个API设计文件的变更历史
相关任务 使用场景 操作步骤 查看实例 查看实例详情,包括实例的基本信息、配置参数、负载通道和环境管理。 找到需要查看的实例,单击实例名称或实例卡片右上角的“查看控制台”。 单击“实例信息”页签,查看实例基础信息、计费信息和管理信息等。 单击“配置参数”页签,查看参数信息。 单击“负载通道”页签,查看通道信息。
在当前应用关联的实例中,根据实际业务选择实例,查看当前实例下包含的API,以及API基本信息。 单击API名称,查看API详情。 支持批量发布、下线、删除API。 单个支持编辑、调试、授权等操作,可参见APIs管理。 父主题: API管理
表1 应用相关任务 相关任务 使用场景 操作步骤 查看应用 查看应用下不同区域关联的不同实例资源和项目资源,包含应用信息、实例信息、调用密钥、APPCode等。 在搜索框中输入需要查看的应用名称。 单击应用名称,进入应用详情页面,查看应用ID、实例状态、集成应用、项目ID等。 权限管理
DK的获取地址。 SDK列表 提供了ROMA API支持的SDK列表,您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言 Github地址 Reference Java huaweicloud-sdk-java-v3
上架目录 将API产品上架到API目录,供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 选择需要上架的API产品,单击产品名称。 在“版本列表”中,选择上架版本,单击“上架”。
账号用户可管理其下所有IAM用户所创建的应用和资源,IAM用户只能管理自己创建的应用和资源,默认无法查看其他IAM用户创建的应用和资源。您可以通过应用授权的方式,把应用下的资源共享给同一账号下的其他IAM用户来查看和使用。 前提条件 已购买ROMA Connect实例或APIG实例。 已创建项目资源。