检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建API设计 ROMA API提供了可视化的API在线设计能力,及接口规范性检查,帮助用户快速设计标准的RESTful API。在开始设计API前,您需要创建一个设计文件。 首次创建API设计支持新建和导入两种方式。 本地无API设计文件可创建API文件。
调用成功时,返回HTTP状态码为“200”和Response信息。 调试失败时,返回HTTP状态码为4xx或5xx,具体错误信息请参考错误码。 您可以通过调整请求参数与参数值,发送不同的请求,验证API服务。 后续操作 API调试成功后,您可以发布API到环境上。
支持简易认证 简易认证指APP认证方式下调用API时,在HTTP请求头部消息增加一个参数X-Apig-AppCode,而不需要对请求内容签名,ROMA API也仅校验AppCode,不校验请求签名,从而实现快速响应。 注意仅支持HTTPS方式调用,不支持HTTP方式。
API产品上架到API目录后,消费者可通过“Explorer”功能在线调试API。如果通过APP认证来调用API,那么产品需要先订阅才能选择凭证调用API。 前提条件 应用关联的实例已开启公网访问并配置弹性IP,可参考实例配置参数。 操作步骤。 登录ROMA API控制台。
对后端服务进行签名 Java Python C#
代码仓库是代码托管服务存储代码的云端仓库。 单击“在线开发”,通过云端开发环境CloudIDE开发代码,请参考在线开发。 单击“克隆/下载”,克隆或下载代码。 在线开发 单击“在线开发”页签。或在“代码仓”区域,单击“在线开发”。
在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。 根据下表相关任务,了解如何管理API。
API服务管理 创建API服务 导出API服务 生成产品 绑定域名 配置环境和环境变量 配置网关响应 父主题: API管理
ROMA API提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API服务管理中新增网关响应,其中响应内容符合JSON格式即可。
在页面下方显示请求消息和响应结果,若调试成功,状态码显示“200”。 图7 调试 步骤八:绑定域名 单击“基本信息”页签。 在“域名管理”区域,单击“绑定独立域名”。 填写域名配置信息。 表6 独立域名配置 参数 配置说明 域名 填写要绑定的域名。
什么是ROMA API ROMA API是为API提供全生命周期治理的服务,解决API的设计、实现、管理、消费、以及分析等全流程场景的管理问题。
在页面上单击服务名称,进入API服务详情页面。 单击页面右上角的“导出”。 在页面中配置导出参数,完成后单击“导出”,导出结果可在页面右侧查看,同时支持下载到本地。 表1 API服务导出配置 参数 配置说明 API服务 选择待导出API所在的API服务。
表6 Mock类型定义后端服务 服务参数 参数说明 Mock状态码 需升级高版本SHUBAO组件后,方可设置。 Mock返回结果 Mock一般用于开发调试验证。
父主题: API服务管理
在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。 选择需要发布的API,在页面右上角单击“发布”。
签名密钥 签名密钥用于后端服务验证API的身份,在API请求后端服务时,保障后端服务的安全。
绑定域名 您需要为API服务绑定一个或多个独立域名,每个API服务最多可以绑定5个独立域名,同一独立域名只能绑定一个服务。绑定域名即在域名和服务之间建立映射关系,将已有的独立域名绑定到API服务上。
实现API的内部市场 ROMA API提供API产品目录以及订阅系统,API的管理者可将API包装成产品上架到API目录中供其他订阅者使用,订阅者可通过查看API的详细文档以及在线调试来自由的选择需要订阅的API产品。
服务器在返回指定的HTTP响应码时,判定响应成功。可同时指定多个响应码。 通道内服务器配置 服务器添加方式 选择添加服务器方式,目前支持“选择云服务器”和“指定服务器地址”。 单击“完成”,创建完成。 父主题: 实例管理
父主题: API服务管理