检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
导入API设计文件,从“API设计”中选择设计文件导入,单击“确定”。 导入Swagger文件,从本地导入文件,单击“打开”。 参考下表配置后端。 表1 后端配置参数说明 参数 参数说明 后端名称 后端的名称。 归属项目 自动读取当前应用已关联Devcloud服务中的项目。 新建代码仓
中各阶段遇到的问题,帮助企业快速实现API经济,持续构建高质量的API服务能力。 表1 产品功能 功能 说明 API可视化设计 ROMA API集成了标准的Swagger编辑器,支持编辑器编辑和表单编辑两种方式,并提供规范性检查功能,使用户可以快速、高效的在线进行API Swagger文档的设计。
创建应用成功后,在“应用管理”的列表中显示新创建应用的基本信息,同时也支持权限管理、编辑、删除等操作管理应用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 应用管理”。 根据下表相关任务,了解如何管理应用。
在当前应用关联的实例中,根据实际业务选择实例。 单击“自定义认证”页签。 在自定义认证页面,单击“创建自定义认证”。 在创建自定义认证弹框中,根据下表填写参数信息。 表1 自定义认证参数 信息项 描述 认证名称 您自定义的认证名称,用于区分不同的自定义认证。 类型 前端:对API的访问进行认证鉴权。
Access Key)。 图1 credential.csv文件内容 AK/SK生成步骤: 注册并登录管理控制台。 将鼠标移至用户名,在下拉列表中单击“我的凭证”。 单击“访问密钥”。 单击“新增访问密钥”,进入“新增访问密钥”页面。 按照界面提示输入验证码或登录密码,单击“确定”,下载密钥,请妥善保管。
单击“添加扩展字段”,定义扩展字段。 表1 定义扩展字段 信息项 描述 Key 填写Key值。 显示名 填写扩展字段名称。 显示样式 填写扩展字段的值,支持文本框、单选框、复选框和下拉列表的形式。 配置值 填写扩展字段的值,显示样式非“文本框”时,配置值必填。 必填 若勾选,表示配置扩展字段时,扩展字段内容不能为空。
如忽略问题,可单击“继续导入”。 (可选)可视化设计API文件。 单击“表单”页签,您可以创建多个API文件或对API文件进行分类,以及可视化编辑API接口等。 在“API列表”区域,单击,创建API。 在“API列表”区域,单击,对API进行分类管理。 单击“文件基本信息”页签,查看设计文件基本信息。
本小节介绍使用API的基本流程。 获取相关信息。 已获取IAM的Endpoint,具体请参见地区和终端节点。 在管理控制台,将鼠标移至用户名,在下拉列表中单击“我的凭证”,查看“项目ID”。 获取用户Token,并设置成环境变量,Token用于后续调用其他接口鉴权。 执行以下命令,获取用户Token。
Finish”,完成工程导入。 在右侧Maven页签,双击“compile”进行编译。 图2 编译工程 返回“BUILD SUCCESS”,表示编译成功。 右键单击BackendSignatureApplication,选择“Run”运行服务。 图3 运行服务 “ApigatewaySignatureFilter
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 单击产品名称。 在“版本列表”中选择版本。 单击“添加API”。 在弹窗中选择API,单击“确定”。 后续操作 如需对外提供API服务,可将API产品上架目录。 父主题:
... } } } OnAuthorization函数为签名校验代码。校验流程如下:使用正则表达式解析Authorization头。得到key和signedHeaders。 1 2 3 4 5 6 7 8 9 10 11
在页面上单击服务名称,进入API服务详情页面。 在“环境变量”区域,单击“添加环境变量”,选择待添加变量的环境名称。 填写变量相关信息,单击“确定”。 图2 新增变量 表1 新增变量 参数 配置说明 变量名 变量的名称,必须与创建API时定义的变量标识完全相同。 变量值 变量路径。 父主题: API服务管理
API增加的系统响应头(x-apig-*,x-request-id等),包括ROMA API提供的CORS功能增加的响应头。 配置参数说明 表1 配置参数说明 参数 配置说明 Name 响应头名称。每个策略中不能添加重复名称的响应头(不区分大小写),且最多添加10条响应头。 Value
在页面上单击服务名称,进入API服务详情页面。 单击页面右上角的“导出”。 在页面中配置导出参数,完成后单击“导出”,导出结果可在页面右侧查看,同时支持下载到本地。 表1 API服务导出配置 参数 配置说明 API服务 选择待导出API所在的API服务。 运行环境 选择待导出API所在的部署环境。 API
return wrapped return wrapper wrapped函数为签名校验代码。校验流程如下:使用正则表达式解析Authorization头。得到key和signedHeaders。 1 2 3 4 5 6 7 8 if "authorization"
定”。 查看日志分析可单击“日志字段说明”,根据日志字段说明分析日志。 访问日志的字段采用空格作为分隔符,按照顺序,每个字段的含义如下: 表1 日志字段说明 序号 字段 说明 1 remote_addr 客户端地址 2 request_id 请求ID 3 api_id API ID
在左侧导航栏选择“API管理 > API策略”。 在当前应用关联的实例中,根据实际业务选择实例。 在“SSL证书管理”页面,单击“创建SSL证书”。 表1 SSL证书配置 参数 配置说明 证书名称 填写SSL证书的名称,根据规划自定义。建议您按照一定的命名规则填写SSL证书名称,方便您快速识别和查找。