腾讯云API网关使用指南

腾讯云API网关是API托管服务。提供API的全生命周期管理,包含发布、管理、运行、维护、下线等。用户可通过API网关实现自身系统集成和服务聚合,还能便捷安全的开放其业务功能和数据,并实现与开发者或合作伙伴的连接。

腾讯云API网关常用操作

  • 快速上手

    • 使用签名密钥的方式构建API
    • 使用Function函数构建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。
请求方法 HTTP method,包括 GET、POST、PUT、PATCH、DELETE、HEAD。
流控策略 用于 API 服务方对 API分组 、用户,按天、小时进行流量限制。
访问授权 授予某个API分组的调用者,调用某个 API分组 的权限
由 API 提供方完成。
后端签名 网关访问API提供方时,通过添加后端签名进行访问。
版本修订 每个API分组可以维护多个版本。每个环境下可指定版本进行发布。
部署列表 服务发布部署。在 API分组 配置完成后,进行发布到具体环境后才可对外提供服务
现有环境包括:测试、预发、线上 。
发布 暴露 API 以便外部能够进行访问的过程。发布的对象是服务
以当前的 API 配置为准。进行发布后,API 才可被外部访问到。
访问密钥 用户需要创建访问密钥, 作为调用 API 时的身份信息 。
APIKey/APISecret API调用者的密钥,网关校验API调用者的访问时使用。
加密计算后放入请求中作为签名信息。
AK/SK Access Key/Access Key Secret京东云用户的密钥。
通常为API定义者使用,用于校验网关与API提供者服务器的通信。

标签