Flask-API für klassenbasierte Views

Flask bietet zwei Arten von klassenbasierten Views, mit denen Sie die View-Logik objektorientiert organisieren können.

ViewIst die grundlegendste klassenbasierte View,MethodViewVerteilt automatisch gemäß HTTP-Methoden.


View-Basisklasse

Attribute/Methoden Beschreibung
methods Klassenattribut, die Liste der von der View akzeptierten HTTP-Methoden. Standardwert None (verwendet den Standardwert von add_url_rule)
decorators Klassenattribut, die Liste der Decorators. Wird in Reihenfolge auf die generierte View-Funktion angewendet
init_every_request Klassenattribut, bool. Wenn True (Standard), wird für jede Anfrage eine neue Instanz erstellt; bei False wird keine neue Instanz erstellt.
provide_automatic_options Klassenattribut, ob OPTIONS automatisch implementiert werden soll. Standardwert None (verwendet die App-Konfiguration)
dispatch_request(**kwargs) Kernmethode, muss überschrieben werden. kwargs sind die URL-Variablen
as_view(name, *class_args, **class_kwargs) Klassenmethode, erstellt eine View-Funktion, die in add_url_rule verwendet werden kann

MethodView-Klasse

Erbt von View, leitet automatisch gemäß der HTTP-Methode an die entsprechende Instanzmethode weiter.

Namenskonventionen für Methoden Beschreibung
get(self, **kwargs) Verarbeitet GET-Anfragen
post(self, **kwargs) Verarbeitet POST-Anfragen
put(self, **kwargs) Verarbeitet PUT-Anfragen
delete(self, **kwargs) Verarbeitet DELETE-Anfragen
patch(self, **kwargs) Verarbeitet PATCH-Anfragen

Nachdem diese Methoden definiert wurden,methodsDas Attribut wird automatisch basierend auf den definierten Methoden festgelegt.


View vs. MethodView

Funktionen View MethodView
Dispatch-Methode Eine einzelne dispatch_request verarbeitet alle Methoden Automatisches Weiterleiten nach Methodennamen (get→GET, usw.)
Anwendbare Szenarien Generische Views, Template-Rendering RESTful-API

Codebeispiele

Beispiel

from flask import Flask, request, session, redirect, url_for
from flask.views import View, MethodView

app = Flask(__name__)

# Einfache View: einzelne dispatch_request
class HelloView(View):
    def dispatch_request(self, name):
        return f"<h1>Hello, {name}!</h1>"

app.add_url_rule("/hello/<name>", view_func=HelloView.as_view("hello"))

# MethodView:RESTful API
class PostAPI(MethodView):
    # Benutzerdefinierte Initialisierung (bei jeder Anfrage aufgerufen)
    def __init__(self):
        self.db = get_database_connection()

    def get(self, post_id=None):
        if post_id is None:
            posts = self.db.query_all_posts()
            return {"posts": posts}
        return self.db.get_post(post_id)

    def post(self):
        data = request.json
        post_id = self.db.create_post(data["title"], data["body"])
        return {"id": post_id}, 201

    def delete(self, post_id):
        self.db.delete_post(post_id)
        return {"message": "deleted"}

# Registrierung: dieselbe View-Funktion verarbeitet mehrere Methoden
post_view = PostAPI.as_view("post_api")
app.add_url_rule("/api/posts", defaults={"post_id": Keine},
                 view_func=post_view, methods=["GET", "POST"])
app.add_url_rule("/api/posts/<int:post_id>",
                 view_func=post_view, methods=["GET", "DELETE"])
Weitere Erweiterungen