API Key認證組件實現了基於API Key進行認證鑒權的功能。支援從HTTP請求的URL參數、要求標頭或Cookie中提取API Key，並將提取到的Key與預配置的憑證列表進行比對，驗證其是否有許可權訪問。
功能類型
認證鑒權
欄位說明
ComponentConfig
參數 | 類型 | 是否必填 | 預設值 | 描述 |
Config | 是 | - | API Key認證配置。 |
ApiKeyConfig
參數 | 類型 | 是否必填 | 預設值 | 描述 |
ApiKeySources | 是 | - | 從請求中提取API Key的方式，僅支援單一提取源。 | |
ApiKeyCredentials | 是 | - | 受信任API Key憑證列表。 |
ApiKeySourcesConfig
參數 | 類型 | 是否必填 | 預設值 | 描述 |
Headers | String[] | 否 | - | 從HTTP要求標頭中提取API Key。 |
Params | String[] | 否 | - | 從URL參數中提取API Key。 |
Cookies | String[] | 否 | - | 從Cookie中提取API Key。 |
ApiKeyCredential
參數 | 類型 | 是否必填 | 預設值 | 描述 |
Provider | 是 | System | 憑證類型。 | |
Credential | String | 條件必填 | - | 憑證值，即API Key字串。 |
ApiKeyCredentialProvider
值 | 描述 |
System | 系統自動產生的憑證。 |
Custom | 使用者上傳的憑證。 |
錯誤碼資訊
HTTP狀態代碼 | 出錯資訊 | 原因說明 |
401 | Client authentication failed. | API Key驗證失敗，包含Key錯誤或未提供API Key的情況。 |