FastAPI에서 요청된 데이터 검증 및 정리를 구현하는 방법

제목: FastAPI에서 요청된 데이터 검증 및 정리를 구현하는 방법

FastAPI는 강력한 데이터 검증 및 정리 기능을 제공하여 강력한 API를 작성하는 데 도움이 되는 사용하기 쉬운 고성능 웹 프레임워크입니다. 이 글에서는 FastAPI에서 요청된 데이터 검증 및 정리를 구현하는 방법을 소개하고 해당 코드 예제를 첨부합니다.

1. FastAPI 애플리케이션 설치 및 생성
먼저 FastAPI와 해당 종속성을 설치해야 합니다. pip를 사용하여 설치할 수 있습니다:

$ pip install fastapi

다음으로 새 Python 파일 app.py를 만들고 필요한 모듈을 가져옵니다.

from fastapi import FastAPI
from pydantic import BaseModel

그런 다음 FastAPI 애플리케이션의 인스턴스를 만듭니다.

app = FastAPI()

2. 생성 데이터 검증을 위한 모델 클래스
FastAPI에서는 pydantic 라이브러리를 사용하여 요청 데이터 검증 및 정리를 위한 모델 클래스를 생성할 수 있습니다. 모델 클래스는 BaseModel을 상속하여 생성됩니다. 모델 클래스에서 유효성을 검사할 필드와 해당 유형을 정의할 수 있습니다.

다음은 사용자 요청의 유효성을 검사하기 위한 모델 클래스를 생성하는 방법을 보여주는 예입니다.

class UserRequest(BaseModel):
    username: str
    age: int
    email: str

위의 예에서는 사용자 이름, 나이, 이메일의 세 가지 필드가 있는 UserRequest 모델 클래스를 정의하고 해당 유형은 문자열이라고 지정했습니다. , 정수 및 문자열.

3. 데이터 확인 및 정리를 위해 모델 클래스 사용
FastAPI에서 데이터 확인 및 정리를 위해 모델 클래스를 사용하려면 모델 클래스를 매개변수에 대한 주석으로 사용하고 모델 클래스의 인스턴스만 사용하면 됩니다. 기능.

다음은 FastAPI에서 데이터 유효성 검사 및 정리를 위해 모델 클래스를 사용하는 방법을 보여주는 예입니다.

@app.post("/user")
def create_user(user: UserRequest):
    """
    创建用户
    """
    # 进行业务逻辑处理
    # ...
    return {"message": "用户创建成功"}

위 예에서는 create_user 함수를 정의하고 데이터 유효성 검사 및 정리를 위해 UserRequest 모델 클래스를 사용했습니다. /user 경로로 POST 요청을 보내면 FastAPI는 요청 데이터가 UserRequest 모델 클래스의 정의를 준수하는지 자동으로 확인합니다.

요청된 데이터가 모델 클래스의 정의를 충족하지 않으면 FastAPI는 400 잘못된 요청 응답을 반환합니다. 요청 데이터가 성공적으로 확인되면 FastAPI는 함수에서 사용할 수 있도록 요청 데이터를 UserRequest 모델 클래스의 인스턴스로 자동 변환합니다.

4. 사용자 정의 검증 기능 및 오류 처리
때로는 복잡한 비즈니스 로직 검증을 수행해야 할 때도 있습니다. 이때 pydantic의 검증 데코레이터를 사용하여 사용자 정의 검증 함수를 작성할 수 있습니다.

다음은 FastAPI에서 사용자 정의 유효성 검사 기능과 오류 처리를 사용하는 방법을 보여주는 예입니다.

from pydantic import validator

class UserRequest(BaseModel):
    username: str
    age: int
    email: str
    
    @validator('age')
    def validate_age(cls, age):
        if age < 0 or age > 120:
            raise ValueError('年龄应在0到120之间')
        return age

위 예에서는 유효성 검사기 데코레이터를 사용하여 verify_age 함수를 정의하고 이를 age 필드에 적용합니다. 함수에는 나이가 0에서 120 사이가 아닌 경우 값 오류를 발생시키는 일부 사용자 지정 유효성 검사 논리가 있습니다.

사용자 지정 확인 기능을 사용한 후 FastAPI는 자동으로 이를 적용하고 확인에 실패하면 400 잘못된 요청 응답을 반환합니다.

요약
이 기사에서는 FastAPI의 모델 클래스를 사용하여 요청 데이터를 확인하고 정리하는 방법을 배웠습니다. 우리는 모델 클래스를 생성하고 이 클래스를 사용하는 함수에서 데이터 검증 및 정리를 구현했습니다. 또한 복잡한 비즈니스 요구 사항을 충족하기 위해 사용자 정의 유효성 검사 기능과 오류 처리를 작성하는 방법도 배웠습니다.

FastAPI는 강력한 데이터 확인 및 정리 기능을 제공하여 API 작성 작업을 크게 단순화하고 API의 안정성과 보안을 향상시킬 수 있습니다. 이 글이 FastAPI의 데이터 검증 및 정리 기능을 이해하고 적용하는 데 도움이 되기를 바랍니다.

위 내용은 FastAPI에서 요청된 데이터 검증 및 정리를 구현하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!