Cara melaksanakan pengesahan dan pembersihan data yang diminta dalam FastAPI

Tajuk: Cara melaksanakan pengesahan dan pembersihan data yang diminta dalam FastAPI

FastAPI ialah rangka kerja web berprestasi tinggi dan mudah digunakan yang menyediakan fungsi pengesahan dan pembersihan data yang berkuasa untuk membantu kami menulis API yang mantap. Artikel ini akan memperkenalkan cara melaksanakan pengesahan dan pembersihan data yang diminta dalam FastAPI, dan melampirkan contoh kod yang sepadan.

1 Pasang dan buat aplikasi FastAPI
Pertama, kita perlu memasang FastAPI dan kebergantungannya. Anda boleh menggunakan pip untuk memasang:

$ pip install fastapi

Seterusnya, cipta fail Python baharu app.py dan import modul yang diperlukan:

from fastapi import FastAPI
from pydantic import BaseModel

Kemudian, buat contoh aplikasi FastAPI:

app = FastAPI()

2. Cipta Kelas model untuk pengesahan data
Dalam FastAPI, kami boleh menggunakan perpustakaan pydantic untuk mencipta kelas model untuk pengesahan dan pembersihan data permintaan. Kelas model dicipta dengan mewarisi BaseModel. Kita boleh menentukan medan yang akan disahkan dan jenisnya dalam kelas model.

Berikut ialah contoh yang menunjukkan cara membuat kelas model untuk mengesahkan permintaan pengguna:

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

Dalam contoh di atas, kami menentukan kelas model UserRequest dengan tiga medan: nama pengguna, umur dan e-mel, dan dinyatakan Jenisnya ialah rentetan , integer dan rentetan.

3 Gunakan kelas model untuk pengesahan dan pembersihan data
Untuk menggunakan kelas model untuk pengesahan dan pembersihan data dalam FastAPI, kami hanya perlu menggunakan kelas model sebagai anotasi untuk parameter dan menggunakan contoh kelas model dalam fungsi.

Berikut ialah contoh yang menunjukkan cara menggunakan kelas model untuk pengesahan dan pembersihan data dalam FastAPI:

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

Dalam contoh di atas, kami mentakrifkan fungsi create_user dan menggunakan kelas model UserRequest untuk pengesahan dan pembersihan data. Apabila kami menghantar permintaan POST ke laluan /user, FastAPI secara automatik akan mengesahkan sama ada data permintaan mematuhi takrifan kelas model UserRequest.

Jika data yang diminta tidak memenuhi definisi kelas model, FastAPI akan mengembalikan respons 400 Bad Request. Jika data permintaan berjaya disahkan, FastAPI akan menukar data permintaan secara automatik kepada contoh kelas model UserRequest untuk kami gunakan dalam fungsi tersebut.

4. Fungsi pengesahan tersuai dan pengendalian ralat
Kadangkala, kami perlu melakukan beberapa pengesahan logik perniagaan yang kompleks Pada masa ini, kami boleh menggunakan penghias pengesahan dalam pydantic untuk menulis fungsi pengesahan tersuai.

Berikut ialah contoh yang menunjukkan cara menggunakan fungsi pengesahan tersuai dan pengendalian ralat dalam 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

Dalam contoh di atas, kami mentakrifkan fungsi validate_age dan menerapkannya pada medan umur menggunakan penghias pengesah. Dalam fungsi tersebut, kami mempunyai beberapa logik pengesahan tersuai yang akan membuang ralat nilai jika umur bukan antara 0 dan 120.

Selepas menggunakan fungsi pengesahan tersuai, FastAPI akan menggunakannya secara automatik dan mengembalikan respons 400 Bad Request apabila pengesahan gagal.

Ringkasan
Dalam artikel ini, kami mempelajari cara menggunakan kelas model dalam FastAPI untuk mengesahkan dan membersihkan data permintaan. Kami mencipta kelas model dan melaksanakan pengesahan dan pembersihan data dalam fungsi yang menggunakan kelas ini. Kami juga mempelajari cara menulis fungsi pengesahan tersuai dan pengendalian ralat untuk memenuhi keperluan perniagaan yang kompleks.

FastAPI menyediakan fungsi pengesahan dan pembersihan data yang berkuasa, yang boleh memudahkan kerja kami menulis API dan meningkatkan kebolehpercayaan dan keselamatan API. Saya harap artikel ini akan membantu anda memahami dan menggunakan fungsi pengesahan data dan pembersihan FastAPI.

Atas ialah kandungan terperinci Cara melaksanakan pengesahan dan pembersihan data yang diminta dalam FastAPI. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!