检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
企业API文档规范统一 当今企业随着系统内部功能逐渐增多,子系统数量成倍增长,各个系统间调用依赖愈发重要,此时拥有一个API接口文档系统显得极为关键。ROMA API提供可视化的API文档编辑器,通过规范化、标准化的API文档形成稳定资产,快速完成内部系统对外接口的统一,有效降低开发成本。
错误码 用户在调用API失败时,系统返回的错误码包含ROMA和APIG的错误码: 在ROMA实例下,系统返回的错误码请参考错误码。 在APIG实例下,系统返回的错误码请参考错误码。 父主题: 调用API
前端自定义认证:如果您希望使用自己的认证系统,而不是APP认证/华为IAM认证对API的访问进行认证鉴权时,您可以使用自定义认证,通过您自定义的函数进行认证鉴权。 后端自定义认证:当不同的后端服务使用不同的认证系统时,导致您需要为不同的认证系统定制化开发API,而APIG通过自定义认证功能,将多种认证系统集成,简
作为中级使用者,在线设计API文件和上架API目录,需要完成以下流程: 图1 中级使用者流程图 步骤一:购买实例 在创建应用前,需要先购买实例。 步骤二:创建应用 应用是一个系统资源的集合,下面可以划分不同的服务。 步骤三:创建API设计 快速在线设计标准的RESTful API。 步骤四:后端开发(可选) 支持一
服务部署到环境上,同时间接地发布API。 已发布到环境的API,在修改配置信息后,需要重新发布才能将修改后的信息同步到环境中。 前提条件 系统已提供了默认发布环境RELEASE,如果您需要把API发布到其他环境,请提前创建环境。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA
None 操作指导 ROMA API 如何创建API设计 02:50 创建API设计 ROMA API 如何创建API产品并上架 02:39 创建API产品 ROMA API 如何订阅API产品 02:40 订阅API产品 计算 云容器引擎 CCE 熟悉云容器引擎控制台 02:35
通过标准Yaml契约,自动生成API框架代码和测试用例,依托CICD(Continuous Integration Continuous Delivery持续集成)能力高效完成产品研发,并实现开发、测试、运行的并行操作,大大提升了产品的研发效率。 多重运行安全防护 API的开放无时无刻
API返回客户端的响应,HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 使用限制 无法修改ROMA API增加的系统响应头(x-apig-*,x-request-id等),包括ROMA API提供的CORS功能增加的响应头。 配置参数说明 表1 配置参数说明
导入API设计文件”。 在弹窗中选择要开放API所在的设计文件,单击“确定”。 系统根据默认API导入规则检测API文件。 如需修复问题,单击“修复问题”根据修改建议修改问题。 如忽略问题,单击“继续导入”。 填写服务名称,或默认系统自动生成的名称。 在“API接口”列表中勾选要开放的API,单击“立即导入”。
环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。
基本概念 应用 API的全生命周期管理在应用中实现,应用是一个系统资源的集合,即多个区域下,多个实例和多个项目等资源的集合。 API设计 API设计提供API文档的标准化设计和变更管控。 API实现 API实现是API开发者在后端开发、部署和业务编排的能力。 API管理 API管
根据下表参数说明,配置参数。 表1 配置参数说明 内容 内容说明 参数 参数的名称。查看参数的具体功能说明,请参考实例配置参数说明。 参数默认值 参数的系统默认值。 参数范围 参数的取值范围。 参数运行值 参数当前的设置值。 更新时间 参数的最近一次更新时间。若参数从未修改过,该更新时间为空。
2.0支持管理中心 主要介绍实例管理和应用管理。实例是一个独立的资源空间,所有的操作都是在实例内进行,不同实例间的资源相互隔离;应用是一个系统资源的集合,API的全生命周期是在应用中实现。 支持区域:华北-北京一、华北-北京四、华东-上海一、华东-上海二、华南-广州、乌兰察布二零二
(可选)配置默认后端的系统参数。如果后端服务需要接收系统运行时产生的参数信息,如网关内置参数、前端认证参数和后端认证参数等,可以通过设置系统参数来实现。ROMA API向后端服务发送请求时,将系统参数添加到请求的指定位置,然后将请求发送给后端服务。 在“系统参数”下,单击“添加系统参数”,添加后端服务请求的系统参数。
Connect源自华为10年+数字化转型实践。聚焦应用和数据联接,提供消息、数据、API、设备集成能力,帮助企业快速、简单的打通并管理Legacy系统与CloudNative应用,联接云上云下,消除数字鸿沟,构建业务敏捷性,驱动数字化转型。 APIG实例 API网关(API Gatewa
个访问密钥,将无法创建访问密钥。 如需修改访问密钥,请删除访问密钥后重新创建。 为了保证历史兼容性,系统会使用访问密钥创建时间作为最近使用时间的初始值。在您使用该访问密钥时,系统将自动刷新最近使用时间。 输入描述信息,单击“确定”。 创建成功后,在“创建成功”弹窗中,单击“立即下载”下载密钥,并妥善保管。
本示例以AK和SK保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。以Linux系统为例在本地将已获取的AK/SK设置为环境变量。 打开终端,输入以下命令打开环境变量配置文件。 vi ~/.bashrc 设置环境变量,保存文件并退出编辑器。
3分钟创建一个游戏类容器应用 05 开发指导 为客户端提供Java、Go、Python、C等多语言的SDK接入,业务后端无需做修改,轻松实现一套系统对接多种业务场景(如移动场景、IoT场景等)。 API认证 APP认证工作原理 APP认证-Java IAM认证 其他认证 自定义认证 对后端服务进行签名
理、API消费和API分析五大流程。API资产从Swagger文档、后端能力、API服务和API产品在流程中轮转,并不断演进。 应用是一个系统资源的集合,API的全生命周期是在应用中实现,因此在开启API的全生命周期管理之前,您需要在“管理中心”先创建应用。 API设计 API设
在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏单击“API设计”。 单击“创建API文件”。 在弹窗中修改“名称”,或默认系统自动生成的名称;根据下表说明,选择模板。 表1 API文件模板 模板类型 类型说明 SimpleAPI 提供简单GET请求样例。 DescriptionWithGFM