搜索

4.5. ActiveDocs 自动填充 API 凭证

download PDF

自动填充 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 也支持向后兼容。
注意

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

API 密钥身份验证示例

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

"parameters": [
  {
    "name": "user_key",
    "in": "query",
    "description": "Your API access key",
    "required": true,
    "schema": {
      "type": "string"
    },
    "x-data-threescale-name": "user_keys"
  }
]

对于使用 x-data-threescale-name 声明的参数,当您登录开发人员门户时,您会看到带有 5 个最新的键、用户键、App Id 或 App 键的下拉列表,具体取决于规格中配置的值。因此,您可以在不需要复制并粘贴值的情况下自动填充输入:

登录后自动填充
Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

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

让开源更具包容性

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

關於紅帽

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

© 2024 Red Hat, Inc.