MIGNON BLOG

파이썬 가상환경에서 FastAPI시작하기

Writen by CHAJEON7월 3, 2024

목차

파이썬 가상환경에서 FastAPI시작하기

FastAPI공식문서

Virtual environment and Install

cd '가상환경을 생성할 파일 디렉토리'
python3 -m venv ./'가상환경이름'
source '가상환경이름'/bin/activate


cd project_folder
python3 -m venv ./env
source env/bin/activate

deactivate //가상환경 종료

위와 같이 파이썬 가상환경을 만든 후에 아래 명령어를 입력해 설치해주면 됩니다.

pip3 install uvicorn fastapi

Import(main.py)

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
    return {"key":"value"}

코드 설명

  • from fastapi import FastAPI: FastAPI 모듈에서 FastAPI 클래스를 가져옵니다.
  • app = FastAPI(): FastAPI 애플리케이션 인스턴스를 생성합니다.
  • @app.get("/"): 루트 경로에 대한 GET 요청을 처리하는 엔드포인트를 정의합니다.
  • def read_root(): 엔드포인트에 요청이 들어왔을 때 실행될 함수를 정의합니다. 함수 이름은 자유롭게 정할 수 있습니다.
  • return {"key": "value"}: JSON 형식의 응답을 반환합니다. FastAPI는 자동으로 파이썬 딕셔너리를 JSON으로 변환하여 클라이언트에 응답합니다.

Run

fastapi dev main.py
  • fastapi dev main.py: Uvicorn을 사용하여 FastAPI 애플리케이션을 실행합니다. main.py은 파일 이름입니다. 이 명령어를 사용하면 자동으로 코드의 수정을 감지해 reload합니다.

서버가 실행되면 브라우저에서 http://127.0.0.1:8000으로 이동하여 응답을 확인할 수 있습니다. JSON 형식으로 {"key": "value"}가 표시될 것입니다.

추가로, FastAPI는 자동으로 Swagger UI와 ReDoc을 생성하여 API 문서를 제공합니다. 브라우저에서 http://127.0.0.1:8000/docs로 이동하면 Swagger UI를, http://127.0.0.1:8000/redoc로 이동하면 ReDoc을 확인할 수 있습니다.

아래 이미지들은 순서대로 기본 http://127.0.0.1:8000, http://127.0.0.1:8000/docs, http://127.0.0.1:8000/redoc의 모습입니다.

관련글