检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
提供如何在API的描述信息中使用markdown语法，使描述信息更直观。 SimpleBookManagementAPI 提供资源管理类的简单API样例。 FileOperation 提供如何定义文件操作类API的简单样例。 Petstore 提供多种复杂API的定义样例。 单击
选择是否开启绿色通道。 说明： 仅能授权自己有权限的应用。 访问参数会被添加到后端签名认证信息中，并发送给后端服务，后端服务根据携带的访问参数返回不同的响应参数。 开启绿色通道后，需要设置白名单和黑名单。白名单中的地址可以不用认证即可调用API；黑名单中的地址不允许调用API。 单击“确定”，完成授权。
参数说明 后端名称 后端的名称。 归属项目 自动读取当前应用已关联Devcloud服务中的项目。 新建代码仓 设置后端代码保存的代码仓库名称，请不要跟该项目下已有代码仓库重名。 新建流水线 选择使用的流水线，当前仅支持在官方提供的流水线中选择。当前提供的流水线为手动触发流水线，在
访问日志的字段采用空格作为分隔符，按照顺序，每个字段的含义如下： 表1 日志字段说明 序号 字段 说明 1 remote_addr 客户端地址 2 request_id 请求ID 3 api_id API ID 4 user_id 当使用IAM认证访问时，请求方提供的项目ID 5
{iam_endpoint}替换为前提条件中获取的IAM的Endpoint。 {project_id}替换为前提条件中获取的项目ID。 {user_name}和{password}分别替换为连接IAM服务器的用户名和密码。 响应Header中“X-Subject-Token”的值即为Token： X-S
在“配置参数”页面，找到需要配置的参数，单击“编辑”。 根据下表参数说明，配置参数。 表1 配置参数说明 内容 内容说明 参数 参数的名称。查看参数的具体功能说明，请参考实例配置参数说明。 参数默认值 参数的系统默认值。 参数范围 参数的取值范围。 参数运行值 参数当前的设置值。 更新时间 参数的最近一次
根据API使用的安全认证方式，还要获取相关的请求认证信息： APP认证： 签名认证：向API管理者获取该API所授权应用的Key和Secret（或客户端的AppKey和AppSecret），以及用于调用API的SDK。 简易认证：向API管理者获取该API所在应用的AppCode。 其他认证：
认证名称 您自定义的认证名称，用于区分不同的自定义认证。 类型 前端：对API的访问进行认证鉴权。 后端：对后端服务的访问授权。 函数地址 选择用于前端自定义认证或后端自定义认证的函数后端，且创建的函数请求方法为“POST”。如需创建自定义后端，请参考创建用于前端认证的函数后端或创建用于后端认证的函数后端。
Web”，单击“Next”。 图2 Static Web 单击“...”，在弹出的对话框中选择解压后的SDK路径，单击“Finish”。 图3 选择解压后JavaScript的SDK路径 完成工程创建后，目录结构如下。 图4 新建工程JavaScript的目录结构 node_demo.js：Nodejs示例
不论“default（默认）”或是您自定义的网关响应，响应类型范围固定不可修改。您可以修改每种响应的状态码，以及响应内容。 响应内容的错误信息以及其他信息，可通过变量的方式获取，支持的变量见表2。 网关错误响应类型说明 ROMA API提供的错误响应类型见表1，其中响应状态码可以按实际需要做自定义修改。
实现开发、测试、运行的并行操作，大大提升了产品的研发效率。 多重运行安全防护 API的开放无时无刻都在面临着巨大的安全攻击风险（DDoS、XSS、钓鱼、暴力攻击等），ROMA API提供了一套完善的4层防护架构，从接入层、认证层、审计层和转发层，层层保障您的后端安全。 接入层 基
curl 操作场景 使用curl命令调用APP认证的API时，您需要先下载JavaScript SDK生成curl命令，然后将curl命令复制到命令行调用API。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息，具体参见认证前准备。 调用API示例
统显得极为关键。ROMA API提供可视化的API文档编辑器，通过规范化、标准化的API文档形成稳定资产，快速完成内部系统对外接口的统一，有效降低开发成本。 实现API的内部市场 ROMA API提供API产品目录以及订阅系统，API的管理者可将API包装成产品上架到API目录中
APP认证：填写APP认证所使用密钥对的Key。 Basic Auth：填写basic认证所使用的用户名。 Public Key：填写public_key认证所使用的公钥。 Secret 根据选择的密钥类型，填写不同的密钥信息。 APP认证：填写APP认证所使用密钥对的Secret。 Basic
域名，ROMA API对调试域名的访问次数做了限制，每天最多可以访问1000次。 独立域名：您自定义的域名，API调用者通过访问独立域名来调用您开放的API。 前提条件 已备案独立域名，未备案的独立域名无法被访问。 已经将独立的域名解析到该服务的实例IP上，具体方法请参考增加A类型记录集。
ROMA API是为API提供全生命周期治理的服务，解决API的设计、实现、管理、消费、以及分析等全流程场景的管理问题。ROMA API提供了规范化的产品和工具支撑，解决企业发展过程中各阶段遇到的问题，帮助企业快速实现API经济，持续构建高质量的API服务能力。 表1 产品功能 功能 说明
API产品是从服务中挑选想要共享的API组合而成，即为将要上架的API的集合。 新建API产品 创建新的API产品。 添加API到产品 为已创建的API产品添加API。 新建API产品 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费
API指标分析 云监控对ROMA API的运行状态进行日常监控，可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API服务和API。 查看单个API的监控指标 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API分析
在“审核管理”页面，选择“我提交的申请”页签，可查看申请详情。 在“审核管理”页面，选择“我审核的申请”页签，单击“查看详情”，审批订阅信息。 仅支持拥有租户管理员权限者审批。 图5 审批申请 订阅成功后，B部门可以调用A部门的API。 订阅成功后，可以在“订阅与凭证”中查看该凭证下已经订阅成功的产品，也可以取消订阅产品。
jar，也可以使用maven镜像仓库中的java-sdk-core-x.x.x.jar，maven仓库地址为https://mirrors.huaweicloud.com/repository/maven/huaweicloudsdk/com/huawei/apigateway/，配置maven源的方法可参见https://bbs
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
