4.5. ActiveDocs 自动填充 API 密钥

在 3scale ActiveDocs 中自动填充 API 密钥是 OAS 的有用扩展。您可以根据 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
  },
]
应用程序 ID/App 密钥验证示例

x-data-threescale-name 字段是忽略 ActiveDocs 域之外的 OAS 扩展。

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

声明了参数后,ActiveDocs 会自动提示 ActiveDocs 用户登录到 Developer Portal 来获取其密钥,如以下屏幕截图所示:

未登录时自动填充

如果用户已经登录,ActiveDocs 会显示与他们相关的最新五个密钥,以便他们可以立即测试,而无需复制并粘贴其密钥。

登录时自动填充