检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
ROMA API是为API提供全生命周期治理的服务，解决API的设计、实现、管理、消费、以及分析等全流程场景的管理问题。ROMA API提供了规范化的产品和工具支撑，解决企业发展过程中各阶段遇到的问题，帮助企业快速实现API经济，持续构建高质量的API服务能力。 表1 产品功能 功能 说明
通过开放业务能力，使自身服务能力变现，部门B直接订阅部门A开放的API，减少开发时间和成本，实现部门之间业务共享。 前提条件 已创建应用和实例。 开放API A部门将自己的业务变现。 将A部门的业务生成设计文档。 在“API设计”页面，选择“创建API设计 > 导入Swagger
客户端访问控制可控制访问API的客户端IP地址，保护后端服务。您可以为客户端设置访问控制策略，允许/禁止某个IP地址的客户端访问API。 绑定API 在当前凭据下绑定API，绑定后的API拥有当前凭据下的所有策略。 添加AppCode 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA
APP认证工作原理 构造规范请求。 将待发送的请求内容按照与API网关（即API管理）后台约定的规则组装，确保客户端签名、API网关后台认证时使用的请求内容一致。 使用规范请求和其他信息创建待签字符串。 使用AK/SK和待签字符串计算签名。 将生成的签名信息作为请求消息头添加到HTTP请
生成签名的方式和APP认证相同，用AK代替APP认证中的AppKey，SK替换APP认证中的AppSecret，即可完成签名和请求。您可使用Java、Go、Python、C#、JavaScript、PHP、C++、C、Android进行签名和访问。 客户端须注意本地时间与时钟服务器的同步，避免请求消息头X-Sdk-Date的值出现较大误差。
在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中，根据实际业务选择实例。 在页面上单击服务名称，进入API服务详情页面。 单击“API运行”页签。 单击“客户端”右下方的加号，然后单击“跨域资源共享”。 图1
立域名绑定到API服务上。当客户端发送请求时，根据HTTP请求中的域名定位到所属的API服务，再通过HTTPMethod和PATH确定唯一的API。 在绑定域名前，您需要了解以下2个概念： 调试域名：API服务创建后，系统为服务自动分配一个内部测试用的调试域名，此域名唯一且不可更
力，帮助企业快速、简单的打通并管理Legacy系统与CloudNative应用，联接云上云下，消除数字鸿沟，构建业务敏捷性，驱动数字化转型。 APIG实例 API网关（API Gateway）是为企业开发者及合作伙伴提供的高性能、高可用、高安全的API托管服务，帮助企业轻松构建、
从设计者体验和效率出发，提供一款便捷的API编辑器，支持标准Swagger的编辑能力和通俗易懂的表单编辑能力，并融入华为10年累积的API治理规范标准，实现全自动化检测，提升企业API设计的规范性。 自动化代码和用例生成 通过标准Yaml契约，自动生成API框架代码和测试用例，依托CICD（Continuous
配置环境和环境变量 环境是指API的受限使用范围，API只有在发布到环境后，才能被调用。API可以被发布到不同的自定义环境中，如开发环境、测试环境等。RELEASE是系统默认的发布环境，也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境
ROMA API是API全生命周期治理经验的产品，如解决从API设计、实现、管理、消费、分析全流程的管理问题。以API流程规范解决企业业务发展过程中遇到的各阶段问题，提供了规范化的产品跟工具支撑，帮助企业快速实现API经济，并持续构建高质量的API服务能力。 图1 API全生命周期
应用场景 企业API文档规范统一 当今企业随着系统内部功能逐渐增多，子系统数量成倍增长，各个系统间调用依赖愈发重要，此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器，通过规范化、标准化的API文档形成稳定资产，快速完成内部系统对外接口的统一，有效降低开发成本。
ROMA API为企业构建规范化的API全流程体系，将企业服务能力包装成标准API服务，上架市场进行售卖。变现自身服务能力的同时，降低企业研发投入，专注于企业核心业务，提升运营效率。提供全栈的API数据化运营能力，用运行数据驱动规范跟设计的落地，提供更高维度的顶层API架构设计能力。
API返回客户端的响应，HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头，在返回的API响应中指定您配置的响应头。 使用限制 无法修改ROMA API增加的系统响应头（x-apig-*，x-request-id等），包括ROMA API提供的CORS功能增加的响应头。
访问服务前，首先需要得到API的请求方法和请求url。 在API服务详情中的“API运行”页面，查看对应API的请求方法和请求url。 图1 API基础定义 您必须将API发布到环境才能访问。 在API服务详情中的“API运行”页面，查看已发布的环境。 图2 运行环境信息 对于APP认证的API，您
选择实例的计费模式，此处选择“按需计费”。 区域 选择实例所在的区域，此处选择“华北-北京四”。 可用区 选择实例所在的可用区，此处选择“可用区1”。 实例名称 填写实例的名称，根据规划自定义。建议您按照一定的命名规则填写实例名称，方便您快速识别和查找。 实例规格 选择实例的容量规
HTTP响应头管理 API响应是指ROMA API返回客户端的响应，HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头，在返回的API响应中指定您配置的响应头。 HTTP响应头管理策略 3 SLA配置 提前设计接口运行的可靠性和性能指标。 配置SLA 4 导入规则检查 系统
参数，携带的Key（或客户端的AppKey）进行API的调用认证。 app_basic app_basic认证方式开关。启用后，可在API请求中添加“Authorization”参数，携带的Key和Secret（或客户端的AppKey和AppSecret）进行API的调用认证。 app_secret
根据API使用的安全认证方式，还要获取相关的请求认证信息： APP认证： 签名认证：向API管理者获取该API所授权应用的Key和Secret（或客户端的AppKey和AppSecret），以及用于调用API的SDK。 简易认证：向API管理者获取该API所在应用的AppCode。 其他认证：
录能力。 “日志组”和“日志流”设置完成后，单击“确定”。 查看日志分析可单击“日志字段说明”，根据日志字段说明分析日志。 访问日志的字段采用空格作为分隔符，按照顺序，每个字段的含义如下： 表1 日志字段说明 序号 字段 说明 1 remote_addr 客户端地址 2 request_id
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
