消费者
在本文档中,你将学习 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 限流插件执行。
将消费者信息传递给上游
日志记录、分析和审计等场景可能需要将消费者信息传给上游服务。默认情况下,上游无法获得消费者信息。你可以使用 attach-consumer-label 插件在请求头中附带所需信息。
限制消费者访问
你可以使用 consumer-restriction 插件,按消费者名称、HTTP 方法或其他参数限制对 API 的访问。
例如,若要禁止 FetchBot 访问内部服务,同时保留现有消费者配置,请参阅应用基于名单的访问控制。
消费者身份验证和授权
基于 API7 网关的架构主要有两种身份验证和授权模式。
第一种也是最常用的方法是通过第三方身份提供商 (IdP)(例如 Keycloak)对请求进行身份验证和授权:

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