4.5. ActiveDocs による API 認証情報の自動入力
API 認証情報の自動入力は、3scale ActiveDocs の OAS に対する便利なエクステンションです。x-data-threescale-name フィールドには、API 認証モードに応じて以下の値を定義できます。
-
user_keys: API キー認証のみを使用するサービスのアプリケーションのユーザーキーを返します。 -
app_ids: アプリケーション ID/アプリケーションキーを使用するサービスのアプリケーションの ID を返します。後方互換のために、OAuth と OpenID Connect もサポートされています。 -
app_keys: アプリケーション ID/アプリケーションキーを使用するサービスのアプリケーションのキーを返します。後方互換のために、OAuth と OpenID Connect もサポートされています。
x-data-threescale-name フィールドは OAS エクステンションで、ActiveDocs 以外のユースケースでは無視されます。
API キー認証の例
API キー認証のみの場合に "x-data-threescale-name": "user_keys" を使用する例を以下に示します。
"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 つのキー、ユーザーキー、アプリ ID またはアプリキーを含むドロップダウンリストが表示されます。したがって、値をコピーして貼り付けることなく、入力を自動入力できます。