检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
续导入。 在“导入API设计文件”页面,选择实例并编辑服务名称。 进入“全局配置(可选)”页面,并发布。 将API服务生成产品。 在“API运行”页面,单击“生成产品”。 将API产品上架API目录。 进入产品详情页面,提交上架申请。 图1 提交上架申请 在“审核管理”页面,选择“我提交的申请”页签,可查看申请详情。
置的响应头。 使用限制 无法修改ROMA API增加的系统响应头(x-apig-*,x-request-id等),包括ROMA API提供的CORS功能增加的响应头。 配置参数说明 表1 配置参数说明 参数 配置说明 Name 响应头名称。每个策略中不能添加重复名称的响应头(不区分大小写),且最多添加10条响应头。
权限管理 ROMA API中管理员以及IAM用户创建的应用是隔离的,无法互相访问。如果用户想分配权限给不同的IAM用户,需要手动在应用管理内的权限管理进行分配,或在IAM中给用户添加Tenant Administrator权限。 除应用外,IAM用户也需拥有应用关联资源的权限才可进行对应操作,具体可参考:
根据下表相关任务,了解如何管理API设计文件。 表1 管理API设计 相关任务 使用场景 操作步骤 导入到API服务 从API设计文件中挑选部分API接口生成API服务,开放给其他用户使用。 单击对应API设计文件所在行的“导入到API服务”。或单击“编辑器”/“表单”页面中的“导入到API服务”。
API快速实现 ROMA API支持通过导入API文档一键生成代码仓以及流水线,降低开发时间。 API管理 包括API的创建、发布、下线和删除的完整生命周期管理,提供便捷的在线调试能力,支持导入Swagger文档一键生成API,以便更快速地开放API业务。 API策略 支持传统策
API前,您需要先创建应用,然后在应用中创建和管理您的API资源。 账号用户可管理其下所有IAM用户所创建的应用和资源,IAM用户只能管理自己创建的应用和资源,默认无法查看其他IAM用户创建的应用和资源。您可以通过应用授权的方式,把应用下的资源共享给同一账号下的其他IAM用户来查看和使用。 前提条件 已购买ROMA
在弹窗中选择本地路径下的API设计文件,然后单击“打开”导入文件。 导入的YAML或JSON格式文件大小不能超过3MB,否则将无法导入API服务。 在页面中修改服务名称,或默认系统自动生成的服务名称。 在“API接口”列表勾选需要导入的API,单击“立即导入”。 (可选)单击“全局配置(可选)”,请参考全局配置。
参数的名称,如果参数在“Path”位置,那么参数名称需要和“路径”中的名称相同。 说明: 参数名不能是x-apig- 、x-sdk-开头,不能是x-stage,不区分大小写。 参数位置为HEADER时,参数名不能是“Authorization”和“X-Auth-Token”,不区分大小写。 参数类型
API服务管理 创建API服务 导出API服务 生成产品 绑定域名 配置环境和环境变量 配置网关响应 父主题: API管理
创建后端 “后端开发”为您提供业界主流框架代码初始化能力,提供一站式创建代码仓、自动生成框架代码、创建编译构建等流水线任务能力,使后端开发无需从零开始。后端开发流程如下图所示: 图1 后端开发流程图 创建后端 后端是一种以业务功能为主的服务设计概念,每一个后端都具有自主运行的业务
如需查看发布历史,单击“更多”,选择“发布历史”。 图2 查看发布历史 后续操作 API发布完成后,您可直接将API服务生成产品,或从API服务中挑选部分API组合生成产品。 父主题: APIs管理
改参数后使用。具体代码说明请参考调用API示例。 调用API示例 在工程中引入sdk。 1 using APIGATEWAY_SDK; 生成一个新的Signer, 填入AppKey和AppSecret。 1 2 3 Signer signer = new Signer(); signer
常。 异常阈值 执行健康检查时,判定服务器状态异常的连续检查失败次数。例如“异常阈值”设置为“5”,则在连续5次检查失败时,判定服务器的状态异常。 超时时间 健康检查的响应超时时间,单位为秒,超过时间无响应则认为检查失败。 间隔时间 连续两次检查的间隔时间,单位为秒。 HTTP响应码
Code”。 在弹窗中配置AppCode,完成后单击“确定”。 表1 配置AppCode 参数 配置说明 生成方式 选择AppCode的生成方式。 自动生成:由系统随机生成AppCode。 手动输入:自定义AppCode。 AppCode 仅手动输入方式需要填写AppCode的值。
"apig-sdk/go/core" 生成一个新的Signer,输入AppKey和AppSecret。 s := core.Signer{ Key: "4f5f626b-073f-402f-a1e0-e52171c6100c", Secret: "******", } 生成一个新
#include "signer.h" 生成一个新的Signer, 填入AppKey和AppSecret。 Signer signer("4f5f626b-073f-402f-a1e0-e52171c6100c", "******"); 生成一个新的RequestParams,指定
在工程中引入signer.js。 var signer = require('./signer') var http = require('http') 生成一个新的Signer,填入AppKey和AppSecret。 var sig = new signer.Signer() sig.Key =
调用API示例 在工程中引入apig_sdk。 1 2 from apig_sdk import signer import requests 生成一个新的Signer,填入AppKey和AppSecret。 1 2 3 sig = signer.Signer() sig.Key =
您可以在线调试API,确保API的功能正常。 步骤八:绑定域名 创建API服务生成的域名仅用于调试使用,您需要为API服务绑定独立的访问域名。 步骤九:创建产品 将已创建的API服务生成产品。 步骤十:上架目录 将生成的产品上架到目录中,供消费者查看和订阅。 步骤十一:订阅产品 在API目录中,订阅产品。
在页面下方返回结果回显区域打印API调用的Response信息。 调用成功时,返回HTTP状态码为“200”和Response信息。 调试失败时,返回HTTP状态码为4xx或5xx,具体错误信息请参考错误码。 您可以通过调整请求参数与参数值,发送不同的请求,验证API服务。 后续操作