检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
管理API产品 API产品创建完成后,在产品列表中显示新创建API产品信息,同时也支持下架、下线等操作管理API。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 根据下表相关任务,了解如何管理API产品。
产品规格差异 ROMA API无具体规格指标,请参考: APIG专享版产品规格说明 ROMA Connect产品规格说明 CodeArts产品规格说明
Name:填写“apig-sdk-maven-demo”。 Build system:选择“Maven” JDK:用户自己的版本。 IDEA支持在当前窗口或新窗口创建工程。此处,在弹窗中单击“New Window”。 把示例工程中的“src”和“libs”文件夹复制到apig-sdk-maven-demo工程下。
uthorizationFilter,对API网关(即API管理)的请求做签名校验。 API绑定签名密钥后,发给后端的请求中才会添加签名信息。 编写一个Controller,提供GET、POST、PUT和DELETE四个接口,且加入ApigatewaySignatureFilter的Attribute。
计费说明 ROMA API本身不收费,但需先关联资源才可使用对应功能。请参考: 专享版APIG计费说明 ROMA Connect计费说明 CodeArts计费说明
// ApigatewaySignatureFilter.java @Component @WebFilter(filterName = "ApigatewaySignatureFilter", urlPatterns = "/*") public class ApigatewaySignatureFilter
通过Explorer调试API “Explorer”功能支持可视化调试和查看API文档。API产品上架到API目录后,消费者可通过“Explorer”功能在线调试API。如果通过APP认证来调用API,那么产品需要先订阅才能选择凭证调用API。 前提条件 应用关联的实例已开启公网
现一个wrapper,对API网关(即API管理)的请求做签名校验。 API绑定签名密钥后,发给后端的请求中才会添加签名信息。 编写一个返回“Hello World!”的接口,方法为GET、POST、PUT和DELETE,且使用requires_apigateway_signature的wrapper。
on没有上线函数服务,则不支持自定义认证。 支持简易认证 简易认证指APP认证方式下调用API时,在HTTP请求头部消息增加一个参数X-Apig-AppCode,而不需要对请求内容签名,ROMA API也仅校验AppCode,不校验请求签名,从而实现快速响应。 注意仅支持HTTP
企业内部开放API及文档 本章节讲述企业内部如何开放API及文档。企业内部之间通过ROMA API将服务或数据变现,内部之间相互调用实现资源共享。 例如,部门A在ROMA API开放API,设计API、生成产品并上架到API目录,部门B通过API目录查看和订阅API。此时,部门A
配置网关响应 网关响应指ROMA API未能成功处理API请求,从而产生的错误响应。ROMA API提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API服务管理中新增网关响应,其中响应内容符合JSON格式即可。 例如,“default”网关的响应内容为:
API提供的开放API的SDK语言版本,列举了最新版本SDK的获取地址。 SDK列表 提供了ROMA API支持的SDK列表,您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言 Github地址 Reference Java
Studio官方网站下载。 获取SDK 下载SDK的最新版本,获取“ApiGateway-csharp-sdk.zip”压缩包,解压后目录结构如下: 名称 说明 apigateway-signature\Signer.cs SDK代码 apigateway-signature\HttpEncoder
的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 使用限制 无法修改ROMA API增加的系统响应头(x-apig-*,x-request-id等),包括ROMA API提供的CORS功能增加的响应头。 配置参数说明 表1 配置参数说明 参数 配置说明
应用状态显示异常是什么原因? 应用的状态基于应用关联的资源状态来显示: 应用关联的ROMA/APIG实例状态异常,或者关联ROMA集成应用不存在时,应用资源会变成异常状态。 有一个应用资源状态显示异常,整个应用的状态就会显示异常。 修复或移除对应的异常资源,应用状态会恢复正常。
安装Python插件 获取SDK 下载SDK的最新版本,获取“ApiGateway-python-sdk.zip”压缩包,解压后目录结构如下: 名称 说明 apig_sdk\__init__.py SDK代码 apig_sdk\signer.py main.py 示例代码 backend_signature
使用APP认证调用API 认证前准备 APP认证工作原理 Java Go Python C# JavaScript PHP C++ C Android curl
给用户添加Tenant Administrator权限。 除应用外,IAM用户也需拥有应用关联资源的权限才可进行对应操作,具体可参考: APIG权限管理 ROMA Connect权限管理 CodeArts权限管理
通过您自定义的函数进行认证鉴权。 后端自定义认证:当不同的后端服务使用不同的认证系统时,导致您需要为不同的认证系统定制化开发API,而APIG通过自定义认证功能,将多种认证系统集成,简化API开发的复杂度。您只需要在ROMA API中创建自定义的函数认证,ROMA API通过此
签名认证 使用获取的SDK对API请求进行签名,具体请参考APP认证开发。 简易认证 在ROMA API请求中添加Header参数“X-Apig-AppCode”,参数值为获取API的请求信息中获取到的AppCode。 双重认证 在API请求参数中增加自定义认证信息进行认证。 凭证认证