[FastAPI] 미들웨어

 

🐰 FastAPI 공식문서를 보면서 개인적으로 정리한 글 입니다.

 

미들웨어를 FastAPI 응용 프로그램에 추가할 수 있다. 

"미들웨어"는 특정 경로 작동에 의해 처리되기 전, 모든 요청에 대해서 동작하는 함수, 모든 응답이 반환되기 전에도 동일하게 동작

1. 응용 프로그램으로 오는 요청을 가져온다.
2. 요청 또는 다른 필요한 코드를 실행 시킬 수 있다.
3. 요청을 응용 프로그램의 경로 작동으로 전달하여 처리한다.
4. 애플리케이션의 경로 작업에서 생성한 응답을 받는다.
5. 응답 또는 다른 필요한 코드를 실행시키는 동작을 할 수 있다.
6. 응답을 반환한다.

 

미들웨어 만들기

함수 상단에 @app.middleware("http") 데코레이터를 사용할 수 있다.

import time

from fastapi import FastAPI, Request
import asyncio

app = FastAPI()

# request의 수행시간을 측정하는 미들웨어


@app.middleware("http")
async def add_process_time_header(request: Request, call_next):
    start_time = time.time()
    response = await call_next(request)
    process_time = time.time() - start_time
    formatted_time = time.strftime("%H:%M:%S", time.gmtime(process_time))
    response.headers["X-Process-Time"] = formatted_time
    return response


@app.get("/")
async def getItem():
    await asyncio.sleep(5)
    return {"message": "Success"}

 

사용자 정의 헤더는 X- 접두사를 사용하여 추가한다.

 

 

CORS(Cross-Origin Resource Sharing)

웹 애플리케이션에서 발생하는 동일 출처 정책(Same-Origin Policy)을 우회하여 다른 출처(도메인, 프로토콜 또는 포트가 다른)의 리소스에 접근할 수 있게 해주는 메커니즘.

 

동일 출처 정책은 보안상의 이유로 웹 브라우저에서 적용되는 정책으로, 스크립트나 스타일 시트 등의 리소스가 웹 페이지의 출처와 동일한 출처에서 온 것인지를 확인하고, 다른 출처에서 온 리소스에는 접근을 제한한다.

 

그러나 다른 출처에서 필요한 리소스에 접근해야 하는 상황이 발생하는데, 이때 CORS를 사용한다.

 

서버에서 클라이언트에게 특정 출처로부터의 요청을 허용하는 권한을 부여하는 방식

주로 API 호출, Ajax 요청과 같은 비동기 요청에 많이 사용된다.

 

일반적으로 서버 측에서 응답 헤더에 Access-Control-Allow-Origin 헤더를 설정하여 특정 출처로부터의 요청을 허용한다.

헤더의 값으로 출처를 명시하거나, *를 사용하여 모든 출처 허용.

 

FastAPI는 CORSMiddleware를 사용하여 CORS를 사용할 수 있다.

from fastapi import FastAPI
from fastapi.middleware.cors import CORSMiddleware

app = FastAPI()
# 허용할 출처
origins = [
    "http://localhost.tiangolo.com",
    "https://localhost.tiangolo.com",
    "http://localhost",
    "http://localhost:8080",
]
# 미들웨어 추가
app.add_middleware(
    CORSMiddleware,
    allow_origins=origins,
    allow_credentials=True,
    allow_methods=["*"],
    allow_headers=["*"],
)


@app.get("/")
async def main():
    return {"message": "Hello World"}

 

add_middleware의 인자들은 다음과 같다.

• allow_origins : 교차-출처 요청을 보낼 수 있는 출처의 리스트
• allow_origin_regex : 교차-출처 요청을 보낼 수 있는 출처를 정규표현식 문자열로 나타냄(ex. 'https://.*\.example\.org') 
• allow_credentials : 교차-출처 요청시 쿠키 지원 여부를 설정, 기본값은 False, True일 경우 allow_origins는 반드시 특정 출저를 지정해야함.
• allow_methods : 교차-출처 요청을 허용하는 HTTP 메소드 리스트, 기본값은 ['GET']
• allow_headers : 교차-출처를 지원하는 HTTP 요청 헤더의 리스트, 기본값은 []
• expose_headers : 브라우저에 접근할 수 있어야 하는 모든 응답 헤더를 가리킴, 기본값은 []
• max_age : 브라우저가 CORS 응답을 캐시에 저장하는 최대 시간을 초 단위로 설정, 기본값은 600

 

미들웨어는 두 가지 특정한 종류의 HTTP 요청에 응답한다.

• CORS 사전 요청
  • Origin or Access-Control-Request-Method 헤더와 함께 전송하는 모든 OPTIONS 요청
  • 이 경우 미들웨어는 들어오는 요청을 가로채 적절한 CORS 헤더와, 정보 제공을 위한 200 or 400 응답

 

• 단순 요청
  • Origin 헤더를 가진 모든 요청
  • 이 경우 미들웨어는 요청을 정상적으로 전달하지만, 적절한 CORS 헤더를 응답에 포함