FastAPI는 강력한 파이썬 웹 프레임워크로, 사용하기 쉽고 빠른 API를 만들 수 있습니다. API의 장점 중 하나는 클라이언트로부터의 입력을 제어할 수 있고, 유효성을 검사할 수 있다는 것입니다. 이를 통해 잘못된 데이터 입력을 방지하고 안정적인 API를 구축할 수 있습니다.

파라미터 유효성 검사

FastAPI에서 파라미터의 유효성을 검사하는 것은 쉽습니다. 파라미터의 유효성을 검사하려면 파라미터에 대한 유효성 규칙을 정의한 후 해당 규칙을 적용하면 됩니다.

예를 들어, FastAPI에서 Query나 Path 파라미터를 검사하기 위해서는 Query나 Path 함수를 사용하고, 그 앞에 ...을 붙여 유효성 검사를 할 수 있습니다. 이를 통해 해당 파라미터가 필수이거나, 허용 가능한 값의 범위를 설정할 수 있습니다.

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}

위 코드에서 Query(..., min_length=3, max_length=50)은 q 파라미터의 값이 3자 이상 50자 이하여야 함을 정의합니다.

유효성 검사 오류 처리

FastAPI는 자동으로 파라미터의 유효성을 검사하고, 잘못된 값이 들어오면 클라이언트에게 적절한 오류 메시지를 보냅니다. 이는 개발자가 별도로 오류 처리를 구현하지 않아도 되는 장점을 제공합니다.

결론

FastAPI를 사용하면 파라미터의 유효성을 검사하는 일이 매우 간편해집니다. 이를 통해 안정적이고 안전한 API를 구축할 수 있으며, 클라이언트와의 상호작용이 원활해집니다. FastAPI의 강력한 유효성 검사 기능을 적극적으로 활용하여 안정적인 API를 구축해보세요.

참고: https://fastapi.tiangolo.com/tutorial/query-params-validation/