获取API的调用信息 在调用API前,您需要向API提供方获取API的调用信息。 获取API的请求信息 向API提供方获取API的“域名”、“请求方法”、“API URL”、“请求参数”和“Headers”。 获取API的调用凭据 根据API使用的安全认证方式不同,还要获取相关的请求认证信息,具体参考表1。
API列表 创建API 导入API 导出API 发布API 授权API 调试API 下线API 开启跨域访问 父主题: API网关代理
API开放 安全性 可用性 可维护性 生命周期管理 父主题: 规范要求
生产API 使用场景 如果您想要使用API中心提供的工具开发API,请参考本章指导操作。 操作步骤 下面以API Arts工具为例,描述如何开发API并上架API至API中心门户网站。 进入API中心服务页面。 选择左侧导航栏中的“API工具库”。 单击API Arts工具右下角的“前往使用”,进入API
API生产 安全性 可用性 易用性 可维护性 父主题: 规范要求
API订阅管理 您可以在API中心门户网站中,通过订阅API,获取API资产服务商的联系方式。如果您想要查看您在API中心门户网站中已经订阅的所有API,或对已经订阅的API单个或批量取消订阅,可以参考本章指导操作。 查看已经订阅的所有API:参考查看订阅的所有API。 对已经订
开放API 上架API至API中心门户网站 注册API到网关代理
用API。 单击API资产,查看API资产的开发文档。 在需要调试的接口详情页面,单击“在线调试”。 部分API未提供调试功能,具体以详情页面展示的信息为准。 对于需要付费购买的API(来源于华为云市场的API),单击API资产,在API资产详情页面,单击“API接口”页签下的“调试API”,在线调试API。
API工具库 该页面展示的是一些开发API的工具。通过这个页面的工具可以开发API,然后通过创建API资产,将开发好的API分享至API中心。 操作步骤 下面以API Arts工具为例,描述如何开发API并上架API至API中心门户网站。 进入API中心服务页面。 选择左侧导航栏中的“API工具库”。
产品架构 图1 API中心产品架构 API中心主要包括API工具,API门户,API网关代理,API运营四个产品模块: API工具 API中心通过对接集成API开发工具,为API开发者提供简单易用的API工具,帮助开发者高效地设计、测试API。 API门户 API中心构建面向广大
取消入驻服务商 生产API API中心为开发者引入自动化的API工具(如API Arts),帮助API开发者高效设计/开发/测试API。支持从API Arts将开发好的API文件一键式导入API中心。 支持区域: 华北-北京四 使用API Arts开发API API资产分享 API中心服务商
的API分组。 API接口 当“导入方式”为下面几种之一时,支持勾选部分接口导入。如果导入全部接口,则忽略此参数。 OpenAPI API网关 Postman Collection API Arts API URL 当“导入方式”为“URL”时,需要填写API资产的URL地址。 根据表2参数信息配置资产基本信息。
导入API API网关代理支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。
授权API API在创建后,通过指定授权给某些凭据,让指定凭据能够调用API。 仅在API安全认证方式为“APP认证”时,才支持授权给凭据。 单个凭据最多同时授权1000个API。 也可以参考绑定API,将API授权给凭据,与本章所描述方法并无差别。 前提条件 API已发布。 已创建环境。
API凭据管理 创建凭据并绑定API 重置Secret 为简易认证绑定AppCode 父主题: API网关代理
同一个API在每个环境中最多记录10条最新的发布历史。 前提条件 已创建环境。 发布API 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 在待发布的API所在行,单击“操作”列的“发布”。 批量发布API:在API列表页,批量勾选API,单击正
在API列表页,单击API所在行“操作”列的“编辑”,修改API参数信息。 创建策略并绑定API 通过对API添加策略,限制对API的访问,从而保护后端服务。 调试API 创建完API后,需要验证服务是否正常,管理控制台提供调试功能。 发布API 创建完成的API,支持发布到不同的环境。API只有在发布到环境后,才支持被调用。
API策略 创建策略 流量控制策略说明 访问控制策略说明 签名密钥策略说明 负载通道 环境管理 父主题: API网关代理
对于需要付费购买的API(来源于华为云市场的API),单击API资产,在API资产详情页面,单击“API接口”页签下的“调试API”,在线调试API。 (可选)获取服务商联系方式。 对于不需要付费购买的API(技术开放型API),可以通过以下步骤获取API服务商的联系方式。 单击API资产。
API分组 创建API分组 域名管理 环境变量 父主题: API网关代理
您即将访问非华为云网站,请注意账号财产安全