[FastAPI] 매개변수

 

🐰 FastAPI 공식문서를 보면서 개인적으로 정리한 글 입니다.

 

Swagger UI / ReDoc

FastAPI는 /docs를 통해 API 문서와 API를 테스트 할 수 있는 Swagger UI 페이지를 제공한다.

 

또 /redoc로 ReDoc 페이지도 제공한다.

 

 

 

경로 매개변수

FastAPI는 파이썬 표준 Type Annotation을 사용하여 경로의 매개변수를 사용하여 함수에 있는 경로 매개변수의 타입을 정할 수 있다.

이 방법을 사용하면 FastAPI는 자동으로 전달 받은 매개변수를 파싱한다.

from fastapi import FastAPI

app = FastAPI()

@app.get("/test/{item_id}")
async def apiTest(item_id: int):
    return {"item_id": item_id}

http://127.0.0.1/test/3

 

item_id를 int로 타입을 정했기 때문에 전달 받은 3을 int 타입으로 파싱한 모습이다.

 

정의한 타입 대신 다른 타입의 값을 전달하면 데이터 검증을 진행하여 잘못되었다고 알려준다.

(모든 데이터 검증은 Pydantic에 의해 내부적으로 수행된다.)

 

routing(경로설정)시 순서를 잘 설정해야 한다. 

{item_id} 같이 매개변수를 전달하는 경로와 고정적인 경로가 있을 때 매개변수를 전달하는 경로를 제일 앞에 선언해야 한다.

from fastapi import FastAPI

app = FastAPI()

@app.get("/test/{item_id}")
async def apiTest1(item_id: str):
    return {"item_id": item_id}


@app.get("/test/hello")
async def apiTest2():
    return {"msg": "안녕하세요"}

만약 고정경로가 먼저 나오면 item_id의 값이 고정 경로(hello)로 인식한다.

 

경로 매개변수를 사전에 정의하고 싶다면 enum(열거형)을 사용하면된다.

from fastapi import FastAPI
from enum import Enum
# models
from sklearn.ensemble import RandomForestClassifier
from sklearn.linear_model import LogisticRegression
from sklearn.tree import DecisionTreeClassifier

app = FastAPI()


class ModelName(str, Enum):
    rfc = "RandomForestClassifier"
    logistic = "LogisticRegression"
    tree = "DecisionTreeClassifier"


@app.get("/models/{model_name}")
async def getModel(model_name: ModelName):
    if model_name is ModelName.rfc:
        return {"model_name": "RandomForestClassifier", "model": RandomForestClassifier()}
    if model_name.value == ModelName.logistic:
        return {"model_name": "XGBClassifier", "model": LogisticRegression()}
    if model_name.value == ModelName.tree:
        return {"model_name": "DecisionTreeClassifier", "model": DecisionTreeClassifier()}
    return {"message": "Invalid model name"}

 

 

Starlette의 옵션을 사용할 수 있다.

from fastapi import FastAPI

app = FastAPI()


@app.get("/files/{file_path:path}")
async def read_file(file_path: str):
    return {"file_path": file_path}

 

 

쿼리 매개변수

경로 매개변수의 일부가 아닌 다른 함수 매개변수를 선언하면 "쿼리" 매개변수로 자동 해석한다.

쿼리는 URL에서 ?후에 나오고 &으로 구분되는 키-값 쌍의 집합이다.

from fastapi import FastAPI

app = FastAPI()

fakeDB = [{"item1": "foo"}, {"item2": "bar"}, {"item3": "baz"}]


@app.get("/items")
async def readItem(skip: int = 0, limit: int = 10):
    return fakeDB[skip:skip+limit]

 

"편집기, 데이터 파싱, 데이터 검증, 자동문서화"를 지원한다.

 

 

Query, Path, Field 데코레이터

Query 데코레이터 : 쿼리 매개변수를 처리하는 데 사용한다.

from fastapi import FastAPI, Query

app = FastAPI()

@app.get("/items/")
async def read_items(q: str = Query(..., min_length=3, max_length=50)):
    return {"q": q}

 

...은 기본값

min_length와 max_length로 문자열의 길이 제한을 설정할 수 있다. (q의 길이가 3개)

 

 

Path 데코레이터 : 경로 매개변수를 처리하는 데 사용한다.

from fastapi import FastAPI, Path

app = FastAPI()

@app.get("/items/{item_id}")
async def read_item(item_id: int = Path(..., gt=0)):
    return {"item_id": item_id}

 

...은 기본값

gt=0은 0 초과의 뜻(ge, lt, le, ...)

 

 

Field 데코레이터 : 데이터 모델의 필드를 세부적으로 구성하는 데 사용한다.

from fastapi import FastAPI
from pydantic import BaseModel, Field

app = FastAPI()


class Item(BaseModel):
    name: str = Field(..., title="상품명",
                      description="상품의 이름을 입력하세요.", min_length=3, max_length=50)
    price: int = Field(..., title="가격", description="상품의 가격을 입력하세요.", gt=0)


items: list = []


@app.post("/items/")
async def create_item(item_id: int, item: Item):
    results: dict = {"item_id": item_id, "item": item}
    items.append(results)
    return {"message": "good"}


@app.get("/items/{item_id}")
async def get_item(item_id: int):
    result: Item = None
    for item in items:
        if item['item_id'] == item_id:
            result: Item = item['item']
            break
    return result

 

 

Cookie 매개변수

Cookie 매개변수를 통해 쿠키를 가져올 수 있다.

from fastapi import FastAPI, Cookie, HTTPException
from fastapi.responses import Response
app = FastAPI()

# 쿠키 생성
@app.get("/set-cookie")
async def set_cookie():
    response = Response("Create Cookie")
    response.set_cookie(key="ads_id", value="abc123")
    return response

# 쿠키 가져오기
@app.get("/items/")
async def read_items(ads_id: str = Cookie(None)):
    if ads_id is None:
        raise HTTPException(status_code=400, detail="Ads ID가 필요합니다.")
    return {"ads_id": ads_id}

 

 

 

Header 매개변수

FastAPI에서 요청의 헤더 값을 가져올 수 있도록 도와주는 기능이다.

특정 헤더 값을 필요로 할 때 사용된다.

from fastapi import FastAPI, Header

app = FastAPI()

@app.get("/items/")
async def read_items(user_agent: str = Header(default=None)):
    return {"user_agent": user_agent}