Fast API 배우기 2부 - query parameters

Query Parameter란?

함수에 사용되는 parameter인데 path parameter에 없는 파라미터를 의미한다

 

from fastapi import FastAPI

app = FastAPI()

fake_items_db = [{"item_name": "Foo"}, {"item_name": "Bar"}, {"item_name": "Baz"}]


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

위 코드에서 skip과 limit은 query로 값을 받는 파라미터이다.

 

저 skip과 limit에 값을 넣어주고 싶으면 ? 와 &를 이용한다.

 

아래와 같이 url 요청하면 된다

 

http://127.0.0.1:8000/items/?skip=0&limit=10

 

기본적으로 query parameter에 값을 실어서 보내면 데이터형은 String이 된다.

 

허나 위 예제에서는 query parameter에 데이터 타입을 명시하였다. 그러면 fast api는 자동으로 int형으로 바꿔준다.

 

 

 

Default value

위 예제에서 query parameter는 아래와 같이 default value가 삽입되어 있다.

async def read_item(skip: int = 0, limit: int = 10):

그럼 아래 url의 값은

http://127.0.0.1:8000/items/

아래처럼 자동으로 변한다

http://127.0.0.1:8000/items/?skip=0&limit=10

 

 

Optional 파라미터

만약 인풋이 생략 가능한 query 파라미터를 만들고 싶은경우 파이썬의 None을 이용하면 된다

 

from typing import Optional

from fastapi import FastAPI

app = FastAPI()


@app.get("/items/{item_id}")

async def read_item(item_id: str, q: Optional[str] = None):

    if q:
        return {"item_id": item_id, "q": q}
    return {"item_id": item_id}

 

 

반응형

Query Parameter Type Conversion

역시나 쿼리 파라미터도 패스 파리미터 처럼 타입 컨버전이 가능하다

from typing import Optional

from fastapi import FastAPI

app = FastAPI()


@app.get("/items/{item_id}")

async def read_item(item_id: str, q: Optional[str] = None, short: bool = False):

    item = {"item_id": item_id}
    if q:
        item.update({"q": q})
    if not short:
        item.update(
            {"description": "This is an amazing item that has a long description"}
        )
    return item

 

 

여기서 주목할 변수는 short이다. bool 자료형도 사용이 가능한걸 알았다.

 

아래 쿼리는 모드 같은 값으로 컨버전 된다

 

http://127.0.0.1:8000/items/foo?short=1
http://127.0.0.1:8000/items/foo?short=True
http://127.0.0.1:8000/items/foo?short=true
http://127.0.0.1:8000/items/foo?short=on
http://127.0.0.1:8000/items/foo?short=yes

 

 

Multiple Path and Multiple Query Parameter

 

from typing import Optional

from fastapi import FastAPI

app = FastAPI()



@app.get("/users/{user_id}/items/{item_id}")
async def read_user_item(
    user_id: int, item_id: str, q: Optional[str] = None, short: bool = False
):
    item = {"item_id": item_id, "owner_id": user_id}
    if q:
        item.update({"q": q})
    if not short:
        item.update(
            {"description": "This is an amazing item that has a long description"}
        )
    return item

위의 예제처럼 여러개의 path parameter와 query parameter를 섞어 줄 수 있다.

 

 

 

Required Query Parameter

앞선 예제에서 쿼리파라미터 사용법 2가지를 배웠다

 

1. 쿼리파라미터에 default value값을 넣는다
2. 쿼리파라미터에 None 값을 넣는다. (Optional parameter)

 

두 케이스 다 쿼리파라미터를 required 하지 않는다

 

쿼리파라미터를 반드시 required 하게 만들려면 아래와 같이 하면 된다.

 

• 쿼리 파라미터에 아무값도 넣지 않는다

아래는 required 파라미터의 예제이다.

from fastapi import FastAPI

app = FastAPI()



@app.get("/items/{item_id}")
async def read_user_item(item_id: str, needy: str):
    item = {"item_id": item_id, "needy": needy}
    return item

 

위 예제에서 needy는 아무값이 들어가지도 않았다. 고로 needy에 값을 반드시 넣어주어야한다.

 

아래 url로 needy값을 안넣어 주었다고 하자 그럼 아래와 같은 에러가 나온다

 

http://127.0.0.1:8000/items/foo-item

{"detail":[{"loc":["query","needy"],"msg":"field required","type":"value_error.missing"}]}

 

아래처럼 url에 needy 값을 넣어주면 정상적인 값을 얻는다

http://127.0.0.1:8000/items/foo-item?needy=sooooneedy

{
    "item_id": "foo-item",
    "needy": "sooooneedy"
}