检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
当今企业随着系统内部功能逐渐增多，子系统数量成倍增长，各个系统间调用依赖愈发重要，此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器，通过规范化、标准化的API文档形成稳定资产，快速完成内部系统对外接口的统一，有效降低开发成本。 实现API的内部市场
401 运行服务器，验证代码正确性。下面示例使用JavaScript SDK中的html签名工具生成签名。 填入如图所示字段后，单击“Send request”，复制生成的curl命令，并在命令行中执行，服务器返回200。 如果使用错误的Key和Secret访问，服务器返回401认证不通过。
java”为示例代码，请根据实际情况修改参数后使用。具体代码说明请参考校验后端签名示例。 校验后端签名示例 示例演示如何编写一个基于Spring boot的服务器，作为API的后端，并且实现一个Filter，对API网关（即API管理）的请求做签名校验。 API绑定签名密钥后，发给后端的请求中才会添加签名信息。
C# 操作场景 使用C#语言进行后端服务签名时，您需要先获取SDK，然后打开工程，最后参考校验后端签名示例校验签名是否一致。 准备环境 准备待用的签名密钥的Key和Secret。 已在控制台创建签名密钥，并绑定API，具体请参见创建并使用签名密钥。 下载SDK的最新版本。 获取并安装Visual
API向后端服务发送请求时，将系统参数添加到请求的指定位置，然后将请求发送给后端服务。 在“系统参数”下，单击“添加系统参数”，添加后端服务请求的系统参数。 表8 系统参数配置 数 配置说明 系统参数类型 选择系统参数的类型。 网关内置参数：ROMA API支持配置的参数。 前端认证参数：
SSL证书管理 创建SSL证书 管理SSL证书 父主题： API管理
SDK概述 本文介绍了ROMA API提供的开放API的SDK语言版本，列举了最新版本SDK的获取地址。 SDK列表 提供了ROMA API支持的SDK列表，您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言
配置环境和环境变量 环境是指API的受限使用范围，API只有在发布到环境后，才能被调用。API可以被发布到不同的自定义环境中，如开发环境、测试环境等。RELEASE是系统默认的发布环境，也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境
错误码 用户在调用API失败时，系统返回的错误码包含ROMA和APIG的错误码： 在ROMA实例下，系统返回的错误码请参考错误码。 在APIG实例下，系统返回的错误码请参考错误码。 父主题： 调用API
他用户调用。 作为初级使用者，成功创建API后，您可以在“API运行”页签通过单个发布或批量发布API。 作为中级使用者，在创建API服务时，您可以把服务部署到环境上，同时间接地发布API。 已发布到环境的API，在修改配置信息后，需要重新发布才能将修改后的信息同步到环境中。 前提条件
单击证书名称，查看证书详情。包括序列号、有效期、签名算法、域名等信息。 编辑证书 修改证书信息。 找到需要编辑的证书，单击所在行的“编辑”，即可修改证书信息。 删除证书 删除不需要的证书。 找到需要删除的证书，单击所在行的“删除”，即可删除证书。 父主题： SSL证书管理
调用已发布的API API在发布到环境后，即支持被其他用户调用。根据API所使用的安全认证方式不同，调用API的操作有所差异。 获取API的请求消息 在调用API前，您需要向API管理者获取API的请求信息，包括访问域名、请求协议、请求方法、请求路径以及请求参数。 根据API使用的安全认证方式，还要获取相关的请求认证信息：
API返回客户端的响应，HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头，在返回的API响应中指定您配置的响应头。 使用限制 无法修改ROMA API增加的系统响应头（x-apig-*，x-request-id等），包括ROMA API提供的CORS功能增加的响应头。 配置参数说明
API目录相当于一个资产中心，以产品的形式将API资源上架到API目录中，供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击产品右侧的“订阅”。 在弹框中选择版本号和凭证，填写申请描述。
在“配置参数”页面，找到需要配置的参数，单击“编辑”。 根据下表参数说明，配置参数。 表1 配置参数说明 内容 内容说明 参数 参数的名称。查看参数的具体功能说明，请参考实例配置参数说明。 参数默认值 参数的系统默认值。 参数范围 参数的取值范围。 参数运行值 参数当前的设置值。 更新时间 参数的最近一次
L1：基本功能验证，可用于继承特性的基本功能验证、迭代验收前的基本功能验证等。 L2：重要特性验证，可用于测试版本（非回归版本）中功能测试。 L3：一般功能/非重要功能验证，包括对基本/重要功能的异常测试。 L4：非常特殊输入、场景、阈值条件的用例。 用例描述 用例的描述信息。 选择API接
创建应用 开始使用ROMA API前，您需要先创建应用，然后在应用中创建和管理您的API资源。 账号用户可管理其下所有IAM用户所创建的应用和资源，IAM用户只能管理自己创建的应用和资源，默认无法查看其他IAM用户创建的应用和资源。您可以通过应用授权的方式，把应用下的资源共享给同一账号下的其他IAM用户来查看和使用。
默认导出API服务在所选择环境下的所有API。如果只需要导出个别API，可单击“自定义导出API”，勾选需要导出的API。 API定义范围 选择导出的API服务文件中，API定义字段的类型范围。 基础定义：包括API前端请求定义和响应定义，不包括后端服务定义。其中API前端请求定义除了S
选择是否开启绿色通道。 说明： 仅能授权自己有权限的应用。 访问参数会被添加到后端签名认证信息中，并发送给后端服务，后端服务根据携带的访问参数返回不同的响应参数。 开启绿色通道后，需要设置白名单和黑名单。白名单中的地址可以不用认证即可调用API；黑名单中的地址不允许调用API。 单击“确定”，完成授权。
如忽略问题，单击“继续导入”。 填写服务名称，或默认系统自动生成的名称。 在“API接口”列表中勾选要开放的API，单击“立即导入”。 （可选）单击“全局配置(可选)”。 安全配置。 表1 安全配置参数说明 参数 参数说明 安全认证 API使用的认证方式，推荐使用APP认证。 APP认证：表示由ROMA
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
