API密钥与API网关 - Don't Panic Labs

作者:API传播员 · 2025-11-13 · 阅读时间:3分钟
本文详细介绍了在AWS API网关中使用API密钥进行访问控制的完整流程,包括创建API密钥、配置使用计划以及启用API密钥验证,帮助用户实现精细的API访问管理。

API密钥与API网关:使用指南

API网关是亚马逊提供的一款强大工具,通常用于托管在 AWS Lambda 上的 API 之前。通过 API 网关,我们可以有效地管理和控制对 API 的访问权限。在某些情况下,我们可能需要限制特定用户对某些 API 的访问。实现这一目标的方法有很多,其中最直接和常见的方式是使用 API 密钥。

API 密钥通过 x-API-key 请求头传递,用于验证每个请求的合法性。本文将详细介绍如何在 AWS 控制台中创建和配置 API 密钥,以及如何将其与 API 网关集成。


创建 API 密钥

要开始使用 API 密钥,首先需要在 AWS 控制台中创建一个新的密钥。以下是具体步骤:

  1. 打开 AWS 控制台,导航到 API 网关。

  2. 点击 操作,然后选择 创建 API 密钥

  3. 为您的 API 密钥命名,并点击 保存

  4. 点击 显示 以查看生成的密钥。请妥善保存此密钥,因为它将在后续的 API 调用中使用。


配置使用计划

API 密钥需要与使用计划关联,以便控制访问权限和流量限制。以下是配置使用计划的步骤:

  1. 在 API 网关中,点击 使用计划

  2. 创建一个新的使用计划。

  3. 在使用计划中,您可以设置节流和配额限制(可选)。这些限制可以帮助您管理 API 的使用量。

  4. 将 API 与一个具体的端点关联。

  5. 将 API 密钥与使用计划绑定。


启用 API 密钥验证

默认情况下,API 调用不需要提供 API 密钥。要强制启用 API 密钥验证,请按照以下步骤操作:

  1. 在 API 网关中,点击 资源

  2. 展开您希望保护的资源(例如“任何”)。

  3. API Key Required 设置为 true

完成上述设置后,您的 API 配置应类似于以下示例:


使用 API 密钥进行调用

在启用了 API 密钥验证后,您需要在每次 API 调用中提供密钥。具体来说,API 密钥应通过 x-API-Key 请求头传递。例如,您可以在 Postman 的“身份验证”选项卡中轻松添加此密钥:


总结

API 密钥是控制 API 网关访问权限的一种简单而有效的方式。与 IAM 角色相比,API 密钥的优势在于它可以轻松地允许外部资源访问您的 API,而无需复杂的内部服务配置。通过本文的指导,您可以快速创建和配置 API 密钥,并将其与 API 网关集成,以实现更精细的访问控制。

原文链接: https://dontpaniclabs.com/blog/post/2022/05/25/api-keys-and-api-gateway/