1. FastAPI란?
FastAPI는 Python 기반의 웹 프레임워크로, API를 빠르고 쉽게 구축할 수 있도록 설계되었습니다. 비동기적이며, 타입 주석(type hint)을 지원하여 자동화된 문서화와 유효성 검사를 제공합니다. FastAPI를 사용하면 RESTful API를 빠르게 구현할 수 있으며, 높은 성능을 자랑합니다.
2. 요청 바디란?
HTTP 요청 바디는 클라이언트가 서버에 데이터를 전달할 때 사용하는 방법 중 하나입니다. 주로 POST, PUT, PATCH 등의 HTTP 메서드와 함께 사용됩니다. 요청 바디를 통해 JSON, XML, Form Data 등의 형식으로 데이터를 전송할 수 있습니다.
3. FastAPI의 요청 바디 처리
FastAPI에서는 요청 바디를 쉽게 처리할 수 있도록 다양한 방법을 제공합니다. 이 섹션에서는 FastAPI에서 요청 바디를 처리하는 기본적인 방법과 예제를 다루겠습니다.
3.1. Pydantic을 사용한 요청 바디의 정의
FastAPI는 Pydantic을 사용하여 유효한 데이터 모델을 정의합니다. Pydantic 모델을 정의하면 요청 바디의 구조를 강제로 지정할 수 있으며, 데이터 검증 및 직렬화/역직렬화를 쉽게 처리할 수 있습니다.
from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI()
class Item(BaseModel):
name: str
price: float
is_offer: bool = None
@app.post("/items/")
async def create_item(item: Item):
return item
위의 예제에서는 Item이라는 Pydantic 모델을 정의했습니다. 이 모델은 name, price, is_offer라는 세 가지 속성을 가지고 있습니다. create_item 함수는 POST 요청을 통해 Item 객체를 생성하고 반환합니다.
3.2. 요청 바디의 타입 지정
FastAPI는 요청 바디의 타입을 자동으로 지정하여 적절한 데이터 형식을 사용하도록 도와줍니다. 위의 예제에서 item: Item은 FastAPI에게 이 요청이 Item 모델에 의해 정의된 형식을 갖추어야 함을 알립니다.
from fastapi import FastAPI, HTTPException
from pydantic import BaseModel
app = FastAPI()
class User(BaseModel):
username: str
email: str
full_name: str = None
@app.post("/users/")
async def create_user(user: User):
if user.username == "admin":
raise HTTPException(status_code=400, detail="Username 'admin' is not allowed.")
return user
위의 예제에서 create_user 함수는 User 모델의 인스턴스를 기대하며, 사용자가 ‘admin’이라는 이름을 사용할 경우 예외를 발생시킵니다.
4. 요청 바디와 다양한 MIME 타입
FastAPI는 여러 가지 MIME 타입을 지원합니다. 여기서는 JSON과 Form Data의 요청 바디를 처리하는 방법을 살펴보겠습니다.
4.1. JSON 요청 바디 처리
FastAPI는 기본적으로 JSON 형식의 요청 바디를 처리합니다. 클라이언트가 JSON 데이터를 요청 바디로 전송하면, FastAPI는 자동으로 이를 Python 객체로 변환합니다.
@app.post("/json/")
async def read_json(item: Item):
return {"item_name": item.name, "item_price": item.price}
위의 예제에서 클라이언트가 JSON 형식으로 요청을 보내면 FastAPI가 이를 Item 객체로 변환하고, 서버는 해당 객체의 속성을 사용하여 응답을 구성합니다.
4.2. Form Data 요청 바디 처리
FastAPI는 Form Data 형식으로 데이터를 처리하는 방법도 제공합니다. 이 경우에는 Form 함수를 사용하여 요청 바디의 데이터를 얻을 수 있습니다.
from fastapi import Form
@app.post("/form/")
async def create_form(username: str = Form(...), password: str = Form(...)):
return {"username": username, "password": password}
이 방법은 HTML 폼을 통해 데이터를 전달할 때 유용하게 사용될 수 있습니다. Form(...)는 필수 필드임을 나타냅니다.
5. 에러 처리
FastAPI는 데이터 유효성 검사를 통해 발생하는 오류를 자동으로 처리합니다. 잘못된 데이터 형식이 요청되면, FastAPI는 HTTP 422 상태 코드와 함께 오류 메시지를 반환합니다.
@app.post("/error/")
async def create_user(user: User):
return user
# 클라이언트가 잘못된 데이터 형식으로 요청할 경우:
# {"username": 123, "email": "invalid email"}
위와 같이 잘못된 데이터가 들어올 경우 FastAPI는 자동으로 에러 메시지를 생성하여 클라이언트에 전달합니다.
6. 요청 바디와 보안
요청 바디를 처리할 때는 보안 역시 중요한 요소입니다. 외부에서 들어오는 데이터는 항상 검증하고 종류를 정확히 파악해야 합니다. FastAPI는 SQL 인젝션, XSS와 같은 공격을 방지하기 위한 다양한 기능을 제공합니다.
추가적으로 FastAPI는 OAuth2, JWT 등의 보안 기능을 지원하여 인증 및 권한 부여를 제공할 수 있습니다.
7. FastAPI의 요청 바디 기능 요약
FastAPI는 요청 바디를 처리하는 데 있어 매우 유연하고 강력한 기능을 제공합니다. Pydantic 모델을 활용하여 데이터 구조를 정의하고, 다양한 형식의 데이터를 지원합니다. JSON, Form Data, Multipart 등의 형식을 쉽게 처리할 수 있으며, 오류 처리가 용이합니다.
또한 FastAPI는 비동기 처리를 지원하므로, 높은 성능을 유지하면서도 복잡한 데이터 요청을 처리할 수 있습니다.