FastAPI Tutorial #01

FastAPI 프로젝트를 만들기

01. FastAPI 와 Uvicorn을 설치

$ pip install fastapi
$ pip install 'uvicorn[standard]'

02. 프로젝트 디렉토리를 생성 후 main.py를 다음과 같이 작성한다.

from typing import Optional

from fastapi import FastAPI



app = FastAPI()


@app.get("/")
def read_root():
    return {"Hello": "World"}


@app.get("/items/{item_id}")
def read_item(item_id: int, q: Optional[str] = None):
    return {"item_id": item_id, "q": q}

위의 read_item 메서드에서 query parameter와 path parameter를 지정할 수 있다.

03. 터미널에서 다음 명령어를 실행하여 로컬서버를 동작시킨다.

$ uvicorn main:app --reload

04. 서버가 잘 동작하는지 확인하기

http://127.0.0.1:8000/ 다음 주소로 접속하면 서버가 잘 동작하는 것을
{"Hello": "World"}가 출력되면서 확인할 수 있다.
http://127.0.0.1:8000/docs API swagger가 자동으로 생성해준 API명세서를 확인 할 수 있다.
http://127.0.0.1:8000/items/1?q=FastAPI 다음과 같이 접속하면 read_item 함수로부터 반환받은 {"item_id": 1, "q": FastAPI}가 출력되는 것을 확인 할 수 있다.