检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
通过Explorer调试API “Explorer”功能支持可视化调试和查看API文档。API产品上架到API目录后，消费者可通过“Explorer”功能在线调试API。如果通过APP认证来调用API，那么产品需要先订阅才能选择凭证调用API。 前提条件 应用关联的实例已开启公网
当今企业随着系统内部功能逐渐增多，子系统数量成倍增长，各个系统间调用依赖愈发重要，此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器，通过规范化、标准化的API文档形成稳定资产，快速完成内部系统对外接口的统一，有效降低开发成本。 实现API的内部市场 ROMA
（可选）可视化设计API文件，对接口可视化设计。 （可选）配置SLA。单击。 需要配置SLA的API所在行，单击“配置SLA”。 勾选需要配置SLA的API，单击“批量配置SLA”。 （可选）Mock调测。 开启“Mock”会自动生成Mock服务地址，您可以在可视化窗口对接口地址进行调测。
API提供了规范化的产品和工具支撑，解决企业发展过程中各阶段遇到的问题，帮助企业快速实现API经济，持续构建高质量的API服务能力。 表1 产品功能 功能 说明 API可视化设计 ROMA API集成了标准的Swagger编辑器，支持编辑器编辑和表单编辑两种方式，并提供规范性检查功能，使用户可以快速、高效的在线进行API
HTTP响应头管理策略 API响应是指ROMA API返回客户端的响应，HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头，在返回的API响应中指定您配置的响应头。 使用限制 无法修改ROMA API增加的系统响应头（x-apig-*，x-request-id等），包括ROMA
地址，您可以在可视化窗口对接口地址进行调测。 规范性检查 在API设计过程中提供接口规范性检查，帮助用户快速设计标准的RESTful API。 在页面中单击API设计文件名称，进入API编辑页面。 单击“编辑器”页签。 单击编辑窗口上方的“规范性检查”。 在可视化窗口单击“Sho
务最多可以绑定5个独立域名，同一独立域名只能绑定一个服务。绑定域名即在域名和服务之间建立映射关系，将已有的独立域名绑定到API服务上。当客户端发送请求时，根据HTTP请求中的域名定位到所属的API服务，再通过HTTPMethod和PATH确定唯一的API。 在绑定域名前，您需要了解以下2个概念：
凭据配额用于限制凭据在某个时间周期内的API调用次数，支持自定义重置时间。 绑定访问控制策略 客户端访问控制可控制访问API的客户端IP地址，保护后端服务。您可以为客户端设置访问控制策略，允许/禁止某个IP地址的客户端访问API。 绑定API 在当前凭据下绑定API，绑定后的API拥有当前凭据下的所有策略。
加“apikey”参数，携带的Key（或客户端的AppKey）进行API的调用认证。 app_basic app_basic认证方式开关。启用后，可在API请求中添加“Authorization”参数，携带的Key和Secret（或客户端的AppKey和AppSecret）进行API的调用认证。
权应用的Key和Secret（或客户端的AppKey和AppSecret），以及用于调用API的SDK。 简易认证：向API管理者获取该API所在应用的AppCode。 其他认证：向API管理者获取该API所授权应用的Key和Secret（或客户端的AppKey和AppSecret）或凭证信息。
API服务”。 在当前应用关联的实例中，根据实际业务选择实例。 在页面上单击服务名称，进入API服务详情页面。 单击“API运行”页签。 单击“客户端”右下方的加号，然后单击“跨域资源共享”。 图1 单击跨域资源共享 配置跨域访问控制。 选择已有策略：单击“选择已有策略”后，选择策略名称。
可完成签名和请求。您可使用Java、Go、Python、C#、JavaScript、PHP、C++、C、Android进行签名和访问。 客户端须注意本地时间与时钟服务器的同步，避免请求消息头X-Sdk-Date的值出现较大误差。 API网关（即API管理）除了校验时间格式外，还会
访问日志的字段采用空格作为分隔符，按照顺序，每个字段的含义如下： 表1 日志字段说明 序号 字段 说明 1 remote_addr 客户端地址 2 request_id 请求ID 3 api_id API ID 4 user_id 当使用IAM认证访问时，请求方提供的项目ID
用户拥有“Tenant Administrator”权限）能设置。 凭据管理 2 HTTP响应头管理 API响应是指ROMA API返回客户端的响应，HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头，在返回的API响应中指定您配置的响应头。 HTTP响应头管理策略
调用类型 Synchronous：同步调用。指后端函数服务收到调用请求后立即执行并返回调用结果，客户端发送请求后同步等待，收到后端响应后关闭连接。 Asynchronous：异步调用。客户端不关注请求调用的结果，服务端收到请求后将请求排队，排队成功后请求就返回，服务端在空闲的情况下会逐个处理排队的请求。
API服务”。 在当前应用关联的实例中，根据实际业务选择实例。 在页面上单击服务名称，进入API服务详情页面。 单击“API运行”页签。 单击“客户端”右上方的加号，然后单击“访问控制”。 图1 单击访问控制 配置访问控制。 选择已有策略：单击“选择已有策略”后，选择策略名称。 创建新策略：请参考表1所示输入信息。
API服务”。 在当前应用关联的实例中，根据实际业务选择实例。 在页面上单击服务名称，进入API服务详情页面。 单击“API运行”页签。 单击“客户端”右上方的加号，然后单击“流量控制”。 图1 单击流量控制 配置流量控制。 选择已有策略：单击“选择已有策略”后，选择策略。 创建新策略：请参考表1所示输入信息。
双向认证 仅当“协议”选择“HTTPS”时需要配置。 是否选择“使用backend_client_certificate配置的证书做客户端认证”，若选择，您需在实例详情的“配置参数”页签中提前配backend_client_certificate证书。 路径 仅当“协议”选择
调用类型 Synchronous：同步调用。指后端函数服务收到调用请求后立即执行并返回调用结果，客户端发送请求后同步等待，收到后端响应后关闭连接。 Asynchronous：异步调用。客户端不关注请求调用的结果，服务端收到请求后将请求排队，排队成功后请求就返回，服务端在空闲的情况下会逐个处理排队的请求。
3分钟创建一个游戏类容器应用 3分钟创建一个游戏类容器应用 3分钟创建一个游戏类容器应用 3分钟创建一个游戏类容器应用 05 开发指导 为客户端提供Java、Go、Python、C等多语言的SDK接入，业务后端无需做修改，轻松实现一套系统对接多种业务场景（如移动场景、IoT场景等）。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
