检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
上架目录 将API产品上架到API目录,供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 选择需要上架的API产品,单击产品名称。 在“版本列表”中,选择上架版本,单击“上架”。
配置环境和环境变量 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境
通过Explorer调试API “Explorer”功能支持可视化调试和查看API文档。API产品上架到API目录后,消费者可通过“Explorer”功能在线调试API。如果通过APP认证来调用API,那么产品需要先订阅才能选择凭证调用API。 前提条件 应用关联的实例已开启公网
单击API名称,查看API接口认证方式、请求方法、URL和请求参数。 图11 获取API的请求信息 获取“凭证信息”的Key和Secret。 在左侧导航栏选择“API消费 > API目录”。 单击“订阅与凭证”页签。 选择步骤十一中已创建凭证,查看“凭证信息”的“Key”和“Secret”。 使用接口测试工具配置调用信息。
架到API目录中,供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击产品右侧的“订阅”。 在弹框中选择版本号和凭证,填写申请描述。 您可以使用已
域资源共享和HTTP响应头管理。 传统策略:流量控制、访问控制和签名密钥。 单击“创建策略”,配置策略信息。 插件策略请参考下表配置: 表1 插件策略配置 参数 配置说明 策略名称 填写策略的名称,根据规划自定义。建议您按照一定的命名规则填写策略名称,方便您快速识别和查找。 策略类型
负载通道 是否使用负载通道。 负载通道可允许后端直接访问ECS上面的实例地址。 URL URL地址由请求方法、请求协议、负载通道/后端服务地址和路径组成。 请求方法 GET、POST、DELETE、PUT、PATCH、HEAD、OPTIONS、ANY,其中ANY表示该API支持任意请求方法。
单击“确定”,创建完成。 凭证创建完成后,您还可以执行如下列操作。 去订阅 通过已创建凭证订阅API产品。 重置Secret 在“凭证信息”区域,凭证“Key”和“Secret”是创建凭证后自动生成的,如需修改密码,单击“重置Secret”重置即可。注意重置后无法恢复,请谨慎操作。 编辑凭证 如需修改凭证信息,单击“编辑凭证”即可。
API的全生命周期管理在应用中实现,应用是一个系统资源的集合,即多个区域下,多个实例和多个项目等资源的集合。 API设计 API设计提供API文档的标准化设计和变更管控。 API实现 API实现是API开发者在后端开发、部署和业务编排的能力。 API管理 API管理提供了API服务开放、配置运行策略、API安全配置等能力。
射关系,将已有的独立域名绑定到API服务上。当客户端发送请求时,根据HTTP请求中的域名定位到所属的API服务,再通过HTTPMethod和PATH确定唯一的API。 在绑定域名前,您需要了解以下2个概念: 调试域名:API服务创建后,系统为服务自动分配一个内部测试用的调试域名,
A API提供了规范化的产品和工具支撑,解决企业发展过程中各阶段遇到的问题,帮助企业快速实现API经济,持续构建高质量的API服务能力。 表1 产品功能 功能 说明 API可视化设计 ROMA API集成了标准的Swagger编辑器,支持编辑器编辑和表单编辑两种方式,并提供规范性
在左侧导航栏选择“API消费 > API产品”。 单击“创建API产品”。 根据参数提示,填写产品基本信息。 在“添加版本和API”区域,选择是否创建产品版本,版本号、实例和API服务,勾选API。 只有已部署到RELEASE环境中的API,才能被添加到API产品中。 每个API仅能被添
选择待调试的API,配置API请求参数后,单击“调试”。 在页面下方返回结果回显区域打印API调用的Response信息。 调用成功时,返回HTTP状态码为“200”和Response信息。 调试失败时,返回HTTP状态码为4xx或5xx,具体错误信息请参考错误码。 您可以通过调整请求参数与参数值,发送不同的请求,验证API服务。
0支持虚拟私有云子功能二 虚拟私有云(Virtual Private Cloud,以下简称VPC),为云服务器、云容器、云数据库等资源构建隔离的、用户自主配置和管理的虚拟网络环境,提升用户云上资源的安全性,简化用户的网络部署。 您可以在VPC中定义安全组、VPN、IP地址段、带宽等网络特性。用户可以
API开放API,设计API、生成产品并上架到API目录,部门B通过API目录查看和订阅API。此时,部门A通过开放业务能力,使自身服务能力变现,部门B直接订阅部门A开放的API,减少开发时间和成本,实现部门之间业务共享。 前提条件 已创建应用和实例。 开放API A部门将自己的业务变现。 将A部门的业务生成设计文档。
功能模块 功能描述 相关文档 1 API设计 支持API整体的规划和设计,提供Mock调测和规范性检查。 API设计 2 API管理 支持API服务和API策略能力,提供API服务定义和策略管理。 支持API创建、调试和发布功能。 API管理 3 API消费 支持从服务中挑选的部分A
本手册主要介绍以API设计者、API开发者、API管理者和API消费者角色和流程来定义API的生命周期,包含了API设计、API实现、API管理、API消费和API分析五大流程。API资产从Swagger文档、后端能力、API服务和API产品在流程中轮转,并不断演进。 应用是一个系统
选择下架版本,单击“下架”。 填写下架申请,单击“确定”。 审核申请通过后,产品下架成功。 克隆新版本 创建产品新版本,同步产品基本信息和API,可自行添加API。 选择需要克隆的API产品,单击产品名称。 选择克隆版本,单击“克隆新版本”。 单击“确定”,克隆完成。 在已克隆
审核申请 仅支持拥有租户管理员权限者审批。 单击“我审核的申请”页签。 在待审核申请所在行,单击“查看详情”。 在审核详情页面查看产品基本信息和审核内容。 确认产品信息无误后,在“审核结果”处选择“通过”并填写反馈建议。 若产品信息不正确,在“审核结果”处选择“驳回”并填写反馈建议。
基础定义:包括API前端请求定义和响应定义,不包括后端服务定义。其中API前端请求定义除了Swagger规范定义项外,还包括APIC的一些Swagger扩展字段。 全量定义:包括API前端请求定义、后端服务定义和响应定义。 扩展定义:包括API前端请求定义、后端服务定义和响应定义,还包括AP