[PYTHON/FASTAPI] FastAPI 클래스 : get 메소드에서 경로 매개 변수 사용하기

■ FastAPI 클래스의 get 메소드에서 경로 매개 변수를 사용하는 방법을 보여준다.

※ 경로 매개 변수는 리소스를 식별하기 위해 API 라우팅에 사용된다. 이 매개 변수는 식별자 역할을 하며 웹 애플리케이션을 추가 처리를 할 수 있도록 한다.

▶ main.py


from fastapi  import FastAPI, APIRouter
from pydantic import BaseModel

class TodoItem(BaseModel):
    id   : int
    item : str

todoItemList = []

apiRouter = APIRouter()

@apiRouter.post("/todo")
async def addTodo(todoItem : TodoItem) -> dict:
    todoItemList.append(todoItem)
    return {"message" : "Todo item added successfully"}

@apiRouter.get("/todo")
async def getTodoList() -> dict:
    return {"todoItemList" : todoItemList}

@apiRouter.get("/todo/{todoItemID}")
async def getSingleTodo(todoItemID : int) -> dict:
    for todoItem in todoItemList:
        if todoItem.id == todoItemID:
            return {"todoItem" : todoItem}
    return {"message" : "Todo item with supplied ID doesn't exist."}

fastAPI = FastAPI()

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

@fastAPI.get("/home")
def home():
    return {"message" : "home"}

fastAPI.include_router(apiRouter)

from fastapi import FastAPI, APIRouter

from pydantic import BaseModel

class TodoItem(BaseModel):

id : int

item : str

todoItemList = []

apiRouter = APIRouter()

@apiRouter.post("/todo")

async def addTodo(todoItem : TodoItem) -> dict:

todoItemList.append(todoItem)

return {"message" : "Todo item added successfully"}

@apiRouter.get("/todo")

async def getTodoList() -> dict:

return {"todoItemList" : todoItemList}

@apiRouter.get("/todo/{todoItemID}")

async def getSingleTodo(todoItemID : int) -> dict:

for todoItem in todoItemList:

if todoItem.id == todoItemID:

return {"todoItem" : todoItem}

return {"message" : "Todo item with supplied ID doesn't exist."}

fastAPI = FastAPI()

@fastAPI.get("/")

def root():

return {"message" : "Hello World"}

@fastAPI.get("/home")

def home():

return {"message" : "home"}

fastAPI.include_router(apiRouter)

▶ requirements.txt


annotated-types==0.6.0
anyio==4.3.0
certifi==2024.2.2
click==8.1.7
dnspython==2.6.1
email_validator==2.1.1
exceptiongroup==1.2.1
fastapi==0.111.0
fastapi-cli==0.0.3
h11==0.14.0
httpcore==1.0.5
httptools==0.6.1
httpx==0.27.0
idna==3.7
itsdangerous==2.2.0
Jinja2==3.1.4
markdown-it-py==3.0.0
MarkupSafe==2.1.5
mdurl==0.1.2
orjson==3.10.3
pydantic==2.7.1
pydantic-extra-types==2.7.0
pydantic-settings==2.2.1
pydantic_core==2.18.2
Pygments==2.18.0
python-dotenv==1.0.1
python-multipart==0.0.9
PyYAML==6.0.1
rich==13.7.1
shellingham==1.5.4
sniffio==1.3.1
starlette==0.37.2
typer==0.12.3
typing_extensions==4.11.0
ujson==5.10.0
uvicorn==0.29.0
uvloop==0.19.0
watchfiles==0.21.0
websockets==12.0

annotated-types==0.6.0

anyio==4.3.0

certifi==2024.2.2

click==8.1.7

dnspython==2.6.1

email_validator==2.1.1

exceptiongroup==1.2.1

fastapi==0.111.0

fastapi-cli==0.0.3

h11==0.14.0

httpcore==1.0.5

httptools==0.6.1

httpx==0.27.0

idna==3.7

itsdangerous==2.2.0

Jinja2==3.1.4

markdown-it-py==3.0.0

MarkupSafe==2.1.5

mdurl==0.1.2

orjson==3.10.3

pydantic==2.7.1

pydantic-extra-types==2.7.0

pydantic-settings==2.2.1

pydantic_core==2.18.2

Pygments==2.18.0

python-dotenv==1.0.1

python-multipart==0.0.9

PyYAML==6.0.1

rich==13.7.1

shellingham==1.5.4

sniffio==1.3.1

starlette==0.37.2

typer==0.12.3

typing_extensions==4.11.0

ujson==5.10.0

uvicorn==0.29.0

uvloop==0.19.0

watchfiles==0.21.0

websockets==12.0

▶ FastAPI 서버 실행 명령


uvicorn main:fastAPI --port 8000 --reload

uvicorn main:fastAPI --port 8000 --reload

▶ REST 실행 명령


curl -X "GET" "http://127.0.0.1:8000/todo" -H "accept: application/json"

curl -X 'POST' 'http://127.0.0.1:8000/todo' -H 'accept: application/json' -H 'Content-Type: application/json' -d '{ "id" : 1, "item" : "First Todo is to finish this book!" }'

curl -X 'POST' 'http://127.0.0.1:8000/todo' -H 'accept: application/json' -H 'Content-Type: application/json' -d '{ "id" : 2, "item" : "Second Todo is to finish this book!" }'

curl -X "GET" "http://127.0.0.1:8000/todo/2" -H "accept: application/json"

curl -X "GET" "http://127.0.0.1:8000/todo" -H "accept: application/json"

curl -X 'POST' 'http://127.0.0.1:8000/todo' -H 'accept: application/json' -H 'Content-Type: application/json' -d '{ "id" : 1, "item" : "First Todo is to finish this book!" }'

curl -X 'POST' 'http://127.0.0.1:8000/todo' -H 'accept: application/json' -H 'Content-Type: application/json' -d '{ "id" : 2, "item" : "Second Todo is to finish this book!" }'

curl -X "GET" "http://127.0.0.1:8000/todo/2" -H "accept: application/json"