[FastAPI] API 키로 인증 적용하기 | API KEY

오늘은 FastAPI를 사용해서 API를 제공할 때 API 키를 적용하는 방법에 대해 알아보려고 해요. API 키가 무엇인지, 왜 사용하는지, 그리고 어떻게 적용하는지 설명해 볼게요 ~!

---

API 키란 무엇인가요?

API 키(API Key)는 애플리케이션이 API를 호출할 때 인증 및 권한 부여를 위해 사용하는 고유 식별자예요. API 키는 다음과 같은 이유로 사용돼요:

1. 인증 및 권한 부여: 클라이언트 애플리케이션이 API에 접근할 수 있는 권한이 있는지 확인
2. 사용 추적 및 모니터링: 어떤 클라이언트가 어떤 API 호출을 했는지 추적하고 모니터링
3. 요청 제한: 특정 클라이언트가 일정 시간 내에 보낼 수 있는 요청 수를 제한할 수 있음

 

FastAPI에서 API 키 적용하기

 

API 키를 사용한 인증 미들웨어 작성하기

from fastapi import FastAPI, Depends, HTTPException, Security
from fastapi.security.api_key import APIKeyHeader

app = FastAPI()

API_KEY = "your-secret-api-key"
API_KEY_NAME = "access_token"
api_key_header = APIKeyHeader(name=API_KEY_NAME, auto_error=False)

def get_api_key(api_key_header: str = Security(api_key_header)):
    if api_key_header == API_KEY:
        return api_key_header
    else:
        raise HTTPException(
            status_code=403, detail="Could not validate credentials"
        )

@app.get("/protected-route")
async def protected_route(api_key: str = Depends(get_api_key)):
    return {"message": "You have access to this route"}

@app.get("/unprotected-route")
async def unprotected_route():
    return {"message": "This route is open to everyone"}

 

 

 

Python으로 API 호출하기

import requests

url = "http://localhost:8000/protected-route"
headers = {
    "access_token": "your-secret-api-key"
}

response = requests.get(url, headers=headers)
print(response.json())

 

 

curl로 API 호출하기

curl -X 'GET' \
  'http://localhost:8000/protected-route' \
  -H 'access_token: your-secret-api-key'

 

---

 

이렇게 설정하면 보호된 경로(/protected-route)에 접근할 때 올바른 API 키가 필요해요. API 키가 유효하지 않으면 403 오류를 반환하게 되죠! 여기까지 FastAPI에서 API 키를 적용하는 방법을 알아보았어요. API 개발 시 간단하게 고려해 보는걸 추천드려요 !