4.5. ActiveDocs 自动填充 API 密钥


自动填充 API 密钥是 OAS 在 3scale ActiveDocs 中非常有用的扩展。您可以根据 API 验证模式,使用以下值定义 x-data-threescale-name 字段:

  • user_keys:返回仅使用 API 密钥身份验证的服务应用程序的用户密钥。
  • app_ids:返回使用 App ID/App Key 的服务应用程序的 ID。OAuth 和 OpenID Connect 也支持向后兼容。
  • app_keys:返回使用 App ID/App Key 的服务应用程序的密钥。OAuth 和 OpenID Connect 也支持向后兼容。

API 密钥身份验证示例

以下示例演示了如何将 "x-data-threescale-name": "user_keys" 用于只使用 API 密钥身份验证:

"parameters": [
  {
    "name": "user_key",
    "description": "Your access API Key",
    "type": "string",
    "in": "query",
    "x-data-threescale-name": "user_keys",
    "required": true
  },
]
Copy to Clipboard Toggle word wrap
App ID/App Key 身份验证示例

x-data-threescale-name 字段是一个 OAS 扩展,在 ActiveDocs 域外被忽略。

对于 App ID/App Key 验证模式,为代表应用程序 ID 的参数指定 "x-data-threescale-name": "app_ids",为代表应用程序密钥的参数指定 "x-data-threescale-name": "app_keys"

声明完参数后,ActiveDocs 会自动提示输入 ActiveDocs 用户以登录到开发人员门户,如下所示:

如果用户已经登录,则 ActiveDocs 会显示与它们相关的最新的五个密钥,以便他们能够在无需复制和粘贴密钥的情况下立即进行测试。

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat