检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
对后端服务进行签名 Java Python C#
通过Explorer调试API “Explorer”功能支持可视化调试和查看API文档。API产品上架到API目录后,消费者可通过“Explorer”功能在线调试API。如果通过APP认证来调用API,那么产品需要先订阅才能选择凭证调用API。 前提条件 应用关联的实例已开启公网访问并配置弹性IP,可参考实例配置参数。
单击“浏览代码”,查看代码库。代码仓库是代码托管服务存储代码的云端仓库。 单击“在线开发”,通过云端开发环境CloudIDE开发代码,请参考在线开发。 单击“克隆/下载”,克隆或下载代码。 在线开发 单击“在线开发”页签。或在“代码仓”区域,单击“在线开发”。 通过IDE左侧的资源管理器可以看到后端代码的结构,如下所示。
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。 选择需要发布的API,在页面右上角单击“发布”。 如需批
后端认证需要先添加一个自定义认证,自定义认证通过函数服务实现,在函数服务中编写一个函数,实现您的认证鉴权流程,或者使用函数调用您的统一鉴权服务。 说明: 后端认证依赖函数服务,此功能仅在部分区域开放。 表6 Mock类型定义后端服务 服务参数 参数说明 Mock状态码 需升级高版本SHUBAO组件后,方可设置。
API是为API提供全生命周期治理的服务,解决API的设计、实现、管理、消费、以及分析等全流程场景的管理问题。ROMA API提供了规范化的产品和工具支撑,解决企业发展过程中各阶段遇到的问题,帮助企业快速实现API经济,持续构建高质量的API服务能力。 表1 产品功能 功能 说明 API可视化设计
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。 选择待调试的API,配置API请求参数后,单击“调试”。
靠性和性能指标。 (可选)Mock调测,对接口地址进行调测。 (可选)规范性检查,对接口规范性检查。 (可选)导入到API服务,将已设计的接口导入API服务。 (可选)可视化设计API文件,对接口可视化设计。 (可选)配置SLA。单击。 需要配置SLA的API所在行,单击“配置SLA”。
API服务管理 创建API服务 导出API服务 生成产品 绑定域名 配置环境和环境变量 配置网关响应 父主题: API管理
创建API服务 ROMA API提供了API服务能力,通过API服务把后端服务封装成标准RESTful格式API,并开放给其他用户使用。 目前支持三种创建服务方式: 创建API服务 创建一个简单的服务,不包含API,用户可自行创建API。 导入API设计文件 支持从“API设计”中导入设计文件,同步创建服务。
选择“Run”运行服务。 图3 运行服务 “ApigatewaySignatureFilter.java”为示例代码,请根据实际情况修改参数后使用。具体代码说明请参考校验后端签名示例。 校验后端签名示例 示例演示如何编写一个基于Spring boot的服务器,作为API的后端,
能力。 步骤五:创建API服务 将已创建的API设计文件导入API服务,开放给消费者使用。 步骤六:配置策略 为API绑定流控策略,对API进行流量限制。 步骤七:调试API 您可以在线调试API,确保API的功能正常。 步骤八:绑定域名 创建API服务生成的域名仅用于调试使用,您需要为API服务绑定独立的访问域名。
实例。 在页面上单击服务名称,进入API服务详情页面。 单击页面右上角的“导出”。 在页面中配置导出参数,完成后单击“导出”,导出结果可在页面右侧查看,同时支持下载到本地。 表1 API服务导出配置 参数 配置说明 API服务 选择待导出API所在的API服务。 运行环境 选择待导出API所在的部署环境。
绑定域名 您需要为API服务绑定一个或多个独立域名,每个API服务最多可以绑定5个独立域名,同一独立域名只能绑定一个服务。绑定域名即在域名和服务之间建立映射关系,将已有的独立域名绑定到API服务上。当客户端发送请求时,根据HTTP请求中的域名定位到所属的API服务,再通过HTTPMethod和PATH确定唯一的API。
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 在“网关响应”区域,即可新增或编辑网关响应。 如果修改完默认网关响应后,需要恢复默认配置,单击“恢复默认配置”即可。
签名密钥 签名密钥用于后端服务验证API的身份,在API请求后端服务时,保障后端服务的安全。 签名密钥是由一对Key和Secret组成,当签名密钥创建后,ROMA API向后端服务发送此API的请求时,会增加相应的签名信息,此时需要后端服务依照同样方式进行签名,通过比对签名结果与
} 运行服务器,验证代码正确性。下面示例使用JavaScript SDK中的html签名工具生成签名。 填入如图所示字段后,单击“Send request”,复制生成的curl命令,并在命令行中执行,服务器返回200。 如果使用错误的Key和Secret访问,服务器返回401认证不通过。
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 在“环境变量”区域,单击“添加环境变量”。 每个用户最多创建10个环境。 单击“创建环境”,填写“环境名称”和“描述”。
API提供API产品目录以及订阅系统,API的管理者可将API包装成产品上架到API目录中供其他订阅者使用,订阅者可通过查看API的详细文档以及在线调试来自由的选择需要订阅的API产品。
生成产品 ROMA API支持把API服务中的API资源作为一个产品,共享给其他用户使用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。