消费者
本文介绍 API7 企业版中消费者的基本概念及其用途,并说明如何将消费者信息传递给上游、限制消费者访问,以及对消费者进行身份验证和授权。
概述
消费者代表向 API 网关发送请求并使用后端服务的用户、应用程序或主机。消费者与身份验证系统配合使用。每个消费者都必须至少配置一个身份验证凭据,或通过 Authz-Keycloak 或 OpenID Connect 等插件接入外部身份验证系统。
下图展示了配置了一个路由和两个消费者的 API7 企业版。消费者 FetchBot 是用于获取数据的机器人,JohnDoe 是一个用户。路由和两个消费者都启用了 key-auth 插件,因此使用 API 密钥验证请求。要访问内部服务,FetchBot 在请求中携带 bot-key,JohnDoe 在请求中携带 john-key。

此配置确保只有经过身份验证的请求才能与通过 /petstore 公开的内部服务交互。
- 如果发往 API7 企业版的请求未携带密钥或携带了错误的密钥,请求会被拒绝。
- 如果发往 API7 企业版的请求携带
bot-key,网关会验证该请求来自FetchBot,它向内部服务请求数据。FetchBot上的limit-count限流插件会将 5 秒窗口内的请求数限制为2。未达到限流阈值时,请求会转发至上游服务,达到阈值后则会被拒绝。 - 如果发往 API7 企业版的请求携带
john-key,网关会验证该请求来自JohnDoe,并将其转发至上游端点。
在此场景中,根据插件执行阶段,身份验证插件先于 limit-count 限流插件执行。
消费者身份验证和授权
基于 API7 企业版的架构主要有两种身份验证和授权模式。
第一种也是最常用的方法是通过第三方身份提供商(IdP)(例如 Keycloak)对请求进行身份验证和授权:

在某些环境中,请求可能需要经过多个 IdP 才能转发到上游端点。你可以在同一个消费者上配置多个身份验证插件,每个插件对应一个 IdP。只有所有 IdP 均允许该请求访问后,API7 企业版才会返回成功响应。
第二种是直接在 API 网关上使用内置凭据进行身份验证和授权。当前支持的凭据类型包括密钥认证、基本认证、JWT 认证和 HMAC 认证。
与传统的用户登录类似,每个消费者可以创建多个凭据,所有凭据均关联到同一个消费者身份。应安全存储凭据并定期更新。
每个消费者可使用多个消费者凭据,配置更加灵活。消费者凭据替代了传统的身份验证插件,例如 key-auth、basic-auth、jwt-auth 和 hmac-auth,使用更便捷。
相关阅读
- API 安全
- API 消费