■ Path 클래스를 사용해 OpenAPI 기반 문서 자동 생성시 라우트 정보를 문서화하는 방법을 보여준다.
※ Path 클래스는 첫 인자로 None 또는 …을 받을 수 있다. 첫 번째 인자가 …이면 [경로 매개 변수]를 반드시 지정해야 한다.
※ 경로 매개 변수가 숫자이면 수치 검증을 위한 인자를 지정할 수 있다. 예를 들어 gt(greater than, ~보다 큰), le(less than, ~보다 작은)와 같은 검증 기호를 사용할 수 있다.
▶ main.py
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
from fastapi import FastAPI, APIRouter, Path from pydantic import BaseModel class TodoItem(BaseModel): id : int item : str todoItemList = [] apiRouter = APIRouter() @apiRouter.post("/todo") async def addTodoItem(todoItem : TodoItem) -> dict: todoItemList.append(todoItem) return {"message" : "Todo item added successfully"} @apiRouter.get("/todo") async def getTodoItemList() -> dict: return {"todoItemList" : todoItemList} @apiRouter.get("/todo/{todoItemID}") async def getTodoItem(todoItemID : int = Path(..., title = "The ID of the todo item to retrieve.")) -> 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
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
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 서버 실행 명령
|
1 2 3 |
uvicorn main:fastAPI --port 8000 --reload |
▶ REST 실행 명령
|
1 2 3 4 5 6 7 8 9 |
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" |