更新时间:2023-12-13 GMT+08:00

总览

API网关(API Gateway)是为您提供高性能、高可用、高安全的API托管服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放及业务能力变现。

使用流程

使用API网关进行API的托管流程如下图所示。

图1 API网关

API提供者在API网关中开放自己的API服务,API调用者从API网关中获取并调用API

开放API

企业或开发者通过API网关开放自身的服务与数据,实现业务能力变现。

图2 开放API基本流程
  1. 创建实例

    实例是一个独立的资源空间,所有的操作都是在实例内进行,不同实例间的资源相互隔离。

  2. 创建API分组

    每个API都归属到某一个API分组下,在创建API前应提前创建API分组。

  3. 绑定域名

    在开放API前,您需要为API分组绑定一个独立域名,供API调用者访问API使用。

    在绑定独立域名前,您可以使用系统为API分配的调试域名进行API调试,每天最多可以访问调试域名1000次。

  4. 创建API

    把已有后端服务封装为标准RESTFul API,并对外开放。

    API创建成功后,您可根据业务需求对API设置访问策略:

    • 传统策略
      • 流控控制

        流量控制可限制单位时间内API的被调用次数,保护后端服务。

      • 访问控制

        访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来拒绝/允许某个IP地址或账户访问API。

      • 签名密钥

        签名密钥用于后端服务验证API网关的身份,在API网关请求后端服务时,保障后端服务的安全。

    • 插件策略
      • 跨域资源共享策略说明

        跨域资源共享策略为跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的扩展能力,可快速、灵活的实现API的跨域访问。

      • HTTP响应头管理策略说明

        您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。

      • 流量控制2.0策略说明

        您可以限制单位时间内API的被调用次数,支持参数流控、基础流控和基于基础流控的特殊流控。

      • Kafka日志推送策略说明

        Kafka日志推送策略提供了把API的详细调用日志推送到Kafka的能力,方便用户获取API的调用日志信息。

      • 断路器策略说明

        断路器是API网关在后端服务出现性能问题时保护系统的内置机制。

  5. 调试API

    验证API服务的功能是否正常可用。

  6. 发布API

    把API发布到环境中,API只有在发布到环境后,才支持被调用。

调用API

企业或开发者如何获取并调用他人在API网关开放的API,减少开发时间与成本。

图3 调用API基本流程
  1. 获取API

    获取API的请求信息,包括访问域名、请求协议、请求方法、请求路径以及认证方式等信息。

  2. 创建凭据

    使用APP认证的API,需要在API网关中创建一个凭据,以生成凭据ID和密钥对(Key、Secret)。将创建的凭据绑定API后,使用APP认证调用API。

  3. 获取SDK

    可通过SDK对AK/SK生成签名,并调用API。

  4. 调用API

    通过获取API及API访问地址,调用API。根据API使用认证方式的不同,调用API时需要进行不同的认证鉴权操作。