현대 웹 개발 세계에 뛰어들고 있다면, 당신은 FastAPI에 대해 들어본 적이 있을 것입니다. 이것은 Python으로 API를 구축하기 위한 가장 빠르게 성장하는 프레임워크 중 하나입니다. 이 블로그 포스트에서는 FastAPI를 사용하여 POST 요청을 생성하고 처리하는 방법을 살펴보겠습니다. 당신이 숙련된 개발자이든 이제 막 시작한 개발자이든, 이 가이드는 기본부터 그 이상까지 이해하는 데 도움이 될 것입니다.
FastAPI란 무엇인가요?
FastAPI는 표준 Python 타입 힌트를 기반으로 Python 3.7+로 API를 구축하기 위한 현대적이고 빠른(고성능) 웹 프레임워크입니다. 사용하기 쉽고 Node.js 및 Go와 동등한 높은 성능을 제공하도록 설계되었습니다. 이 프레임워크는 또한 매우 직관적이고 간단하여 초보자와 전문가 모두에게 훌륭한 선택이 됩니다.
왜 FastAPI를 사용해야 할까요?
개발자들이 다른 프레임워크보다 FastAPI를 선택하는 이유는 여러 가지입니다:
- 속도: FastAPI는 빠릅니다. 사실, 현재 사용 가능한 웹 프레임워크 중 가장 빠른 것 중 하나입니다.
- 사용의 용이성: 자동 인터랙티브 문서화(Swagger UI 및 ReDoc 덕분에)를 통해 API를 테스트하는 것이 매우 쉽습니다.
- 데이터 검증: FastAPI는 Pydantic을 활용하여 데이터 검증을 수행하며, 이는 API가 수신하는 데이터가 유효하다는 것을 보장합니다.
- 비동기 준비: 즉시 비동기 프로그래밍을 지원하므로 현대의 고성능 웹 애플리케이션에 적합합니다.
FastAPI 설정하기
POST 요청에 대해 살펴보기 전에, FastAPI를 간단히 설정해 보겠습니다. 시스템에 Python이 설치되어 있어야 합니다. 그런 다음, pip를 사용하여 FastAPI와 Uvicorn과 같은 ASGI 서버를 설치할 수 있습니다:
pip install fastapi uvicorn
FastAPI가 설치되면 간단한 FastAPI 애플리케이션을 만들 수 있습니다. main.py라는 파일을 만드는 것으로 시작하겠습니다:
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
def read_root():
return {"Hello": "World"}
응용 프로그램을 실행하려면 Uvicorn을 사용하십시오:
uvicorn main:app --reload
브라우저를 열고 http://127.0.0.1:8000로 이동하세요. JSON 응답 {"Hello": "World"}를 볼 수 있습니다.
POST 엔드포인트 생성하기
기본 FastAPI 앱이 실행되고 있으니 이제 POST 엔드포인트를 추가해 보겠습니다. POST 요청은 특정 자원에 처리할 데이터를 제출하는 데 사용됩니다. FastAPI에서 POST 요청을 처리하기 위해서는 @app.post 데코레이터를 사용합니다.
다음은 POST 요청을 처리하는 간단한 예입니다:
from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI()
class Item(BaseModel):
name: str
description: str = None
price: float
tax: float = None
@app.post("/items/")
def create_item(item: Item):
return item
이 예제에서:
FastAPI인스턴스를 정의합니다.- 요청 본문의 데이터 구조를 설명하는 Pydantic 모델
Item을 생성합니다. @app.post데코레이터를 사용하여 POST 엔드포인트/items/를 정의합니다.create_item함수는 입력으로Item객체를 받아 반환합니다.
이를 테스트하려면 apidog와 같은 API 클라이언트를 사용하거나 FastAPI에서 제공하는 인터랙티브 Swagger UI를 사용하여 http://127.0.0.1:8000/docs로 가십시오.
데이터 및 검증 처리하기
FastAPI는 요청 데이터를 Pydantic 모델에 대해 자동으로 검증합니다. 데이터가 모델에 맞지 않으면 FastAPI는 검증 오류에 대한 세부정보와 함께 422 상태 코드를 반환합니다.
예를 들어, 다음 JSON 본문으로 /items/에 POST 요청을 보내면:
{
"name": "Item name",
"price": 25.5
}
FastAPI는 Item 모델의 요구 사항을 충족하므로 이 요청을 수락합니다. 그러나 price 필드를 생략하면 FastAPI는 요청을 거부하고 오류를 반환합니다.
FastAPI POST 요청 테스트를 위한 Apidog 사용하기
Apidog는 API 테스트를 위한 강력한 도구입니다. API 요청을 생성하고 저장하며, 이를 컬렉션으로 정리하고 팀과 공유할 수 있습니다.
여기 Apidog를 사용하여 POST 요청을 테스트하는 방법이 있습니다:
- Apidog를 열고 새 요청을 생성합니다.
2. 요청 방법을 POST로 설정합니다.
3. 업데이트하려는 자원의 URL을 입력합니다. 포함하려는 추가 헤더나 매개변수를 추가한 다음 요청을 보내기 위해 “전송” 버튼을 클릭합니다.
4. 응답이 예상한 것인지 확인합니다.
고급 POST 요청
이제 좀 더 고급 시나리오를 살펴보겠습니다. FastAPI는 POST 요청으로 더 많은 작업을 수행할 수 있게 합니다. 예를 들어:
- 파일 업로드 처리:
fastapi에서File및UploadFile을 사용합니다. - 폼 데이터 처리:
fastapi에서Form을 사용합니다. - 경로 매개변수 사용:
path parameters를 POST 요청과 결합합니다.
파일 업로드 처리하기
다음은 FastAPI에서 파일 업로드를 처리하는 예제입니다:
from fastapi import FastAPI, File, UploadFile
app = FastAPI()
@app.post("/uploadfile/")
async def create_upload_file(file: UploadFile):
return {"filename": file.filename}
이 엔드포인트는 파일을 수락하고 파일 이름을 반환합니다. apidog 또는 Swagger UI로 이 테스트를 수행할 수 있습니다.
폼 데이터 처리하기
폼 데이터를 처리하려면 FastAPI의 Form 클래스를 사용하십시오:
from fastapi import FastAPI, Form
app = FastAPI()
@app.post("/login/")
def login(username: str = Form(...), password: str = Form(...)):
return {"username": username}
이 예제는 폼 데이터를 수락하는 로그인 엔드포인트를 생성합니다. 브라우저 또는 API 테스트 도구에서 폼 제출을 사용하여 이를 테스트할 수 있습니다.
경로 매개변수 사용하기
POST 요청과 경로 매개변수를 결합할 수도 있습니다:
from fastapi import FastAPI
app = FastAPI()
@app.post("/users/{user_id}/items/")
def create_item_for_user(user_id: int, item: Item):
return {"user_id": user_id, "item": item}
이 엔드포인트는 user_id 경로 매개변수로 식별되는 특정 사용자에게 아이템을 생성합니다.
결론
FastAPI는 Python으로 강력한 API를 쉽게 구축할 수 있게 하는 강력한 프레임워크입니다. 데이터 검증, 인터랙티브 문서화 및 높은 성능에 대한 지원으로 인해 현대 웹 개발에 탁월한 선택이 됩니다.
이 블로그 포스트에서는 FastAPI 애플리케이션을 설정하고 POST 요청을 처리하는 방법에 대해 다루었습니다. 파일 업로드, 폼 데이터 처리 및 POST 요청과 경로 매개변수 결합과 같은 더 고급 주기도 살펴보았습니다. 이제 FastAPI를 사용하여 POST 요청을 생성하고 처리하는 방법에 대한 확고한 이해를 하게 되었을 것입니다.
간단한 API를 구축하든 복잡한 애플리케이션을 개발하든, FastAPI는 성공하는 데 필요한 도구를 제공합니다. 행복한 코딩 되세요!
