FastAPI中实现可切换的API Key安全认证机制

from fastapi import FastAPI, HTTPException, Security
from fastapi.security import APIKeyHeader
import os

app = FastAPI()

# 模拟API Keys
API_KEYS = ["my_api_key", "another_valid_key"]
# 定义API Key请求头
api_key_header = APIKeyHeader(name="X-API-Key", auto_error=False) # auto_error=False 允许我们自定义错误处理

async def get_api_key_basic(x_api_key: str = Security(api_key_header)):
    """
    基本的API Key验证依赖项。
    如果X-API-Key头不存在或无效，将抛出HTTPException。
    """
    if x_api_key not in API_KEYS:
        raise HTTPException(
            status_code=401,
            detail="Invalid or missing API Key",
            headers={"WWW-Authenticate": "X-API-Key"},
        )
    return x_api_key

@app.get("/protected-basic")
async def protected_route_basic(api_key: str = Security(get_api_key_basic)):
    """
    一个受基本API Key保护的路由。
    """
    return {"message": "Access granted with basic API Key!"}

from fastapi import FastAPI, HTTPException, Security
from fastapi.security import APIKeyHeader
import os
from typing import Optional

app = FastAPI()

# 环境配置：通过环境变量或配置文件控制
# 实际应用中应从环境变量读取，例如：
TEST_MODE: bool = os.getenv("FASTAPI_TEST_MODE", "False").lower() == "true" 
# 示例中为方便测试，也可以直接设置为True或False
# TEST_MODE = True  # 启用测试模式，禁用安全认证
# TEST_MODE = False # 禁用测试模式，启用安全认证

API_KEYS = ["my_api_key", "another_valid_key"]
api_key_header = APIKeyHeader(name="X-API-Key", auto_error=False)

async def get_api_key_switchable(
    # 核心改动在这里：根据TEST_MODE条件性地应用Security依赖
    request_key_header: Optional[str] = Security(api_key_header) if not TEST_MODE else None,
) -> Optional[str]:
    """
    可切换的API Key验证依赖项。
    当TEST_MODE为True时，认证被禁用；否则，API Key必须有效。
    """
    print(f"DEBUG: TEST_MODE: {TEST_MODE}, Received request_key_header: {request_key_header}")

    if TEST_MODE:
        # 在测试模式下，直接返回一个特殊值或None，表示认证已绕过
        return "TEST_MODE_BYPASS" 

    # 非测试模式下，执行正常的API Key验证
    if request_key_header is None or request_key_header not in API_KEYS:
        raise HTTPException(
            status_code=401,
            detail="Invalid or missing API Key",
            headers={"WWW-Authenticate": "X-API-Key"},
        )
    return request_key_header

@app.get("/protected")
async def protected_route(api_key: Optional[str] = Security(get_api_key_switchable)):
    """
    一个受可切换API Key保护的路由。
    """
    if api_key == "TEST_MODE_BYPASS":
        return {"message": "Access granted! (Security bypassed in test mode)"}
    return {"message": f"Access granted with API Key: {api_key}"}