So implementieren Sie die Validierung und Bereinigung angeforderter Daten in FastAPI

Titel: So implementieren Sie die Validierung und Bereinigung angeforderter Daten in FastAPI

FastAPI ist ein leistungsstarkes, benutzerfreundliches Webframework, das leistungsstarke Datenvalidierungs- und Bereinigungsfunktionen bietet, die uns beim Schreiben robuster APIs helfen. In diesem Artikel wird erläutert, wie die Überprüfung und Bereinigung angeforderter Daten in FastAPI implementiert wird, und es werden entsprechende Codebeispiele beigefügt.

1. Installieren und erstellen Sie die FastAPI-Anwendung.
Zuerst müssen wir FastAPI und seine Abhängigkeiten installieren. Sie können pip zum Installieren verwenden:

$ pip install fastapi

Als nächstes erstellen Sie eine neue Python-Datei app.py und importieren die erforderlichen Module:

from fastapi import FastAPI
from pydantic import BaseModel

Dann erstellen Sie eine Instanz der FastAPI-Anwendung:

app = FastAPI()

2. Erstellen Modellklasse zur Datenüberprüfung
In FastAPI können wir die Pydantic-Bibliothek verwenden, um eine Modellklasse zur Überprüfung und Bereinigung von Anforderungsdaten zu erstellen. Modellklassen werden durch Vererbung von BaseModel erstellt. Wir können die zu validierenden Felder und ihre Typen in der Modellklasse definieren.

Hier ist ein Beispiel, das zeigt, wie eine Modellklasse zur Validierung von Benutzeranfragen erstellt wird:

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

Im obigen Beispiel haben wir eine UserRequest-Modellklasse mit drei Feldern definiert: Benutzername, Alter und E-Mail, und angegeben, dass ihre Typen Zeichenfolgen sind , Ganzzahl und Zeichenfolge.

3. Modellklassen zur Datenüberprüfung und -bereinigung verwenden
Um Modellklassen zur Datenüberprüfung und -bereinigung in FastAPI zu verwenden, müssen wir die Modellklasse nur als Annotation für Parameter verwenden und eine Instanz der Modellklasse in verwenden Funktion.

Hier ist ein Beispiel, das zeigt, wie Modellklassen für die Datenvalidierung und -bereinigung in FastAPI verwendet werden:

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

Im obigen Beispiel haben wir eine create_user-Funktion definiert und die UserRequest-Modellklasse für die Datenvalidierung und -bereinigung verwendet. Wenn wir eine POST-Anfrage an den /user-Pfad senden, überprüft FastAPI automatisch, ob die Anfragedaten der Definition der UserRequest-Modellklasse entsprechen.

Wenn die angeforderten Daten nicht der Definition der Modellklasse entsprechen, gibt FastAPI eine 400 Bad Request-Antwort zurück. Wenn die Anforderungsdaten erfolgreich überprüft wurden, konvertiert FastAPI die Anforderungsdaten automatisch in eine Instanz der UserRequest-Modellklasse, damit wir sie in der Funktion verwenden können.

4. Benutzerdefinierte Überprüfungsfunktion und Fehlerbehandlung
Manchmal müssen wir eine komplexe Überprüfung der Geschäftslogik durchführen. Zu diesem Zeitpunkt können wir den Überprüfungsdekorator in Pydantic verwenden, um eine benutzerdefinierte Überprüfungsfunktion zu schreiben.

Hier ist ein Beispiel, das zeigt, wie benutzerdefinierte Validierungsfunktionen und Fehlerbehandlung in FastAPI verwendet werden:

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

Im obigen Beispiel definieren wir eine Validate_age-Funktion und wenden sie mithilfe des Validator-Dekorators auf das Altersfeld an. In der Funktion verfügen wir über eine benutzerdefinierte Validierungslogik, die einen Wertfehler auslöst, wenn das Alter nicht zwischen 0 und 120 liegt.

Nach Verwendung der benutzerdefinierten Verifizierungsfunktion wendet FastAPI diese automatisch an und gibt eine 400 Bad Request-Antwort zurück, wenn die Verifizierung fehlschlägt.

Zusammenfassung
In diesem Artikel haben wir gelernt, wie man Modellklassen in FastAPI verwendet, um Anforderungsdaten zu überprüfen und zu bereinigen. Wir haben eine Modellklasse erstellt und die Datenvalidierung und -bereinigung in Funktionen implementiert, die diese Klasse verwenden. Wir haben auch gelernt, wie man benutzerdefinierte Validierungsfunktionen und Fehlerbehandlung schreibt, um komplexe Geschäftsanforderungen zu erfüllen.

FastAPI bietet leistungsstarke Funktionen zur Datenüberprüfung und -bereinigung, die unsere Arbeit beim Schreiben von APIs erheblich vereinfachen und die Zuverlässigkeit und Sicherheit von APIs verbessern können. Ich hoffe, dass dieser Artikel Ihnen hilft, die Datenvalidierungs- und Bereinigungsfunktionen von FastAPI zu verstehen und anzuwenden.

Das obige ist der detaillierte Inhalt vonSo implementieren Sie die Validierung und Bereinigung angeforderter Daten in FastAPI. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!