是否必须使用API中心的网关代理功能? 不是。如果您的API已经注册在自有网关或者其他第三方网关,API中心仍然支持您创建API资产,将API展示在API中心门户网站。 父主题: API网关代理
获取API的调用信息 在调用API前,您需要向API提供方获取API的调用信息。 获取API的请求信息 向API提供方获取API的“域名”、“请求方法”、“API URL”、“请求参数”和“Headers”。 获取API的调用凭据 根据API使用的安全认证方式不同,还要获取相关的请求认证信息,具体参考表1。
址、健康信息等。 人与人之间的私人消息,如短信、电话通信内容。 API涉及个人数据时,需要提供隐私声明 本条规则是MUST类型的基本规则,可保障API的安全合规。 如果API提供正常业务时涉及个人数据(包含收集、使用、转移、存储等),必须在API发布过程中提供产品隐私声明,描述收
调用已发布的API 调用API 响应消息头 错误码 父主题: API网关代理
响应消息头 调用API时,API网关代理增加如下响应消息头。 X-Apig-Mode: debug表示响应消息头增加API网关代理调试信息。 响应消息头 描述 说明 X-Request-Id 请求ID 所有合法请求,都会返回此参数 X-Apig-Latency 从API网关代理接收请求到后端返回消息头的用时
导入API API网关代理支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录以及使用Rest API。 导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。
本。” API文档按照模板进行写作 本条规则是Should类型的扩展规则,可提升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,单击正上方的“下线”。最多同时批量下线1000个API。 选择API需要下线的环境。 单击“确定”,完成API下线。 后续操作 您将API下线后
授权API API在创建后,通过指定授权给某些凭据,让指定凭据能够调用API。 仅在API安全认证方式为“APP认证”时,才支持授权给凭据。 单个凭据最多同时授权1000个API。 也可以参考绑定API,将API授权给凭据,与本章所描述方法并无差别。 前提条件 API已发布。 已创建环境。
API凭据管理 创建凭据并绑定API 重置Secret 为简易认证绑定AppCode 父主题: API网关代理
束。 必须对API进行统一注册和统一管理,API注册目标系统为API中心。在API发布过程中必须保证API注册信息的准确性,保证API符合国家法规以及安全规定的要求。 API调用成功率>=99.99% 本条规则是MUST类型的基本规则,可保障API的高可用性。 API调用成功定义
创建API分组 API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。您在创建API前,需要先创建API分组。 目前支持两种创建分组方式: 创建API分组 创建一个简单的分组,不包含API,用户可自行创建API。 导入Swagger文件 从本地导入已有的API文件,同步创建分组。
选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。 API 默认导出API分组所在环境的所有已发布的API,如果需要导出个别API,单击“自定义导出API”,勾选需要导出的API名称。 API定义范围 基础定义:只导出API前端定义。其中API前端定义除了
Secret。 绑定API 在“凭据管理”页面,单击凭据名称,进入详情页面。 在“关联API”区域,单击“绑定API”。 选择授权环境、API分组和API。 单击“确定”。 如需解绑API,在API所在行单击“解绑”即可。 也可以参考授权API章节,将API授权给凭据,与本节所描述方法并无差别。
API分组是同一种业务API的集合,API开发者以API分组为单位,管理分组内的所有API。 域名管理 在开放API前,您需要为API分组绑定独立域名,API调用者通过独立域名访问分组内的API。 环境 为了方便管理API的生命周期,API网关代理定义了API受限使用范围,这个受限
新增如下章节: 附录-API治理规范指导 2023-07-14 第七次正式发布。 优化如下章节: 约束与限制 2023-05-22 第六次正式发布。 新增如下章节: 图解API中心 优化如下章节: 产品优势 2023-03-31 第五次正式发布。 优化如下章节: 什么是API中心 应用场景
优化如下章节: 上架API至API中心门户网站 2023-03-31 第六次正式发布。 优化如下章节: 上架API至API中心门户网站 消费API 2023-03-22 第五次正式发布。 优化如下章节: 生产API 2023-03-14 第四次正式发布。 优化如下章节: 生产API 2023-02-10
服务商入驻成功后可以取消入驻吗? 服务商入驻成功后信息还可以修改吗? 2023-04-10 第三次正式发布。 优化如下章节: 为什么要申请入驻服务商? 申请入驻API中心服务商有哪些入口? 服务商入驻审核多久通过? 2023-03-14 第二次正式发布。 优化如下章节: 为什么要申请入驻服务商? 2022-12-14
您即将访问非华为云网站,请注意账号财产安全