Python/FastAPI

[FastAPI] 설치 및 장점

K.Seungmin 2024. 9. 5. 19:51

오늘은 FastAPI를 설치하고 기초 개념을 설명하는 시간을 가져보겠습니다. 저는 아나콘다의 가상환경을 이용해서 설치했고 파이썬은 3.10 버전을 사용했습니다.

FastAPI 설치

$ pip install fastapi

$ pip install uvicorn

fastapi 를 설치하고 추가로 서버 역할을 해주는 uvicorn 을 함께 설치해 줍니다. 추후 main.py 파일을 작성하고 나서 uvicorn 을 통해 실행하는 코드는 다음과 같습니다. 그러면 밑에 나오는 코드를 통해서 서버에 접속할 수 있습니다.

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [28720]
INFO:     Started server process [28722]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

 

FastAPI 의 장점 - API 문서

이제 fastapi 를 사용할 준비가 완료되었습니다. fastapi 는 python 언어를 통해서 사용가능합니다. 먼저 간단한 main.py 함수를 작성해 줍니다.

from fastapi import FastAPI

app = FastAPI()


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

이 함수를 uvicorn 을 통해서 실행시켜 줄 경우 http://127.0.0.1:8000 을 통해서 접속할 수 있습니다. 그러면 {"message": "Hello World"} 라는 문구를 볼 수 있습니다. 그리고 여기서 주소 끝에 /docs/redoc 을 붙여줄 경우 API 문서를 볼 수 있습니다. 이 기능은 fastapi 의 매우 유용한 기능입니다.

/docs

/redoc

 

정리

위의 /docs/redoc 에는 내가 작성한 API 메소드들의 기능들과 Input, Output 을 확인하고 여러 가지 에러를 체크할 수 있는 좋은 UI를 가지고 있습니다. 앞으로 여러가지 기능들을 만들면서 유용하게 쓰일 페이지이기 때문에 잘 기억해 두시면 좋습니다.