Admin

Sie übergeben jede instanzweite Einstellung als Schlüsselwortargument an die Klasse Admin: den Navbar-Titel, den Mount-Pfad, die CSRF- und Authentifizierungskonfiguration sowie das gerenderte Theme.

Grundlegende Verwendung

Importieren Sie zunächst die Klasse Admin aus dem contrib-Paket, das zu Ihrem object-relational Mapper (ORM) passt:

from starlette_admin.contrib.sqla import Admin  # SQLAlchemy
from starlette_admin.contrib.sqlmodel import Admin  # SQLModel
from starlette_admin.contrib.beanie import Admin  # Beanie
from starlette_admin.contrib.mongoengine import Admin  # MongoEngine
from starlette_admin.contrib.tortoise import Admin  # Tortoise ORM

Hier ist eine minimale Konfiguration mit SQLAlchemy:

from sqlalchemy import create_engine
from starlette.applications import Starlette
from starlette_admin.contrib.sqla import Admin, ModelView

from myapp.models import Post

engine = create_engine("sqlite:///admin.sqlite")
app = Starlette()

admin = Admin(
    session_provider=engine,
    title="My Admin",
    base_url="/admin",
    secret_key="a-long-random-string",
)
admin.add_view(ModelView(Post))
admin.mount_to(app)

• title legt den Text in der Navbar und das HTML-Tag <title> fest.
• base_url definiert das Pfadpräfix, unter dem der Admin gemountet wird.
• secret_key signiert die CSRF- und Flash-Cookies.
• add_view registriert ein View, und mount_to erzeugt die Routen und Middleware des Admins, bevor es diese in Ihre Anwendung einhängt.

Jede Klasse Admin akzeptiert alle unten beschriebenen Konfigurationsoptionen, und einige fügen backend-spezifisches Verhalten hinzu:

• contrib.sqla.Admin(session_provider, ...) nimmt als erstes positionales Argument eine Instanz von Engine, AsyncEngine, sessionmaker oder async_sessionmaker entgegen und fügt für Sie DBSessionMiddleware ein. contrib.sqlmodel.Admin ist dieselbe Klasse, die lediglich re-exportiert wird. Siehe SQLAlchemy und SQLModel.
• contrib.beanie.Admin, contrib.mongoengine.Admin und contrib.tortoise.Admin nehmen keine zusätzlichen Konstruktorargumente entgegen, da Beanie, MongoEngine und Tortoise ORM ihre Verbindungen außerhalb des Admins selbst verwalten. mongoengine.Admin registriert außerdem eine Route zum Ausliefern von GridFS-Dateien in mount_to. Siehe Beanie, MongoEngine und Tortoise ORM.

Vollständige Referenz

Der Konstruktor Admin akzeptiert alle folgenden Parameter als Schlüsselwortargumente.

Identität und Branding

logo_url, login_logo_url und favicon_url akzeptieren jeweils entweder einen String oder eine (request) -> str | None-Callable. Verwenden Sie eine Callable, wenn das Branding von der Anfrage abhängt, etwa in einer Multi-Tenant-Anwendung oder wenn Sie mehrere Hostnamen bedienen:

def logo_for_tenant(request):
    return f"https://cdn.example.com/{request.state.tenant}/logo.png"


admin = Admin(engine, title="My Admin", logo_url=logo_for_tenant)

Mounting

Um mehr als einen Admin in derselben Anwendung zu betreiben, geben Sie jeder Instanz ein eigenständiges base_url und route_name. Andernfalls können Links, die von einem Admin generiert werden, zu einem anderen auflösen. Siehe Multiple Admin Instances.

Templates, statische Dateien und Theme

Custom Themes und Templates behandeln diese Optionen im Detail.

Die Startseite

Die Standard-Startseite besteht aus einem Willkommens-Banner plus einem Panel pro registriertem Model View, das jeweils dessen Datensatzanzahl anzeigt. Um sie zu ersetzen, übergeben Sie Ihr eigenes CustomView, typischerweise eine Unterklasse von DefaultIndexView oder ein beliebiges CustomView mit einem widget. Siehe Custom Views & Widgets.

Authentifizierung, Sicherheit und Datenschutz

Das Handbuch Security behandelt alle fünf Parameter ausführlich.

Locale und Zeitzone

Eine vollständige Anleitung finden Sie unter Internationalization & Timezones.

Debugging

admin = Admin(
    session_provider=engine, title="My Admin", secret_key="a-long-random-string", debug=True
)

Debug-Logging ist während der Entwicklung hilfreich. Bei jeder Anfrage wird protokolliert, welche Middleware ausgeführt wurde, welches View die URL aufgelöst hat und warum eine Berechtigungsprüfung bestanden oder fehlgeschlagen ist.

Für einen leichtgewichtigeren Ansatz rufen Sie stattdessen selbst starlette_admin.logging.configure_logging(level=logging.INFO) auf, statt debug=True zu übergeben. So erhalten Sie den Handler ohne die volle DEBUG-Ausführlichkeit.

Views registrieren und mounten

Nachdem Sie die Instanz Admin erstellt haben, registrieren Sie Ihre Views und mounten den Admin in Ihre Anwendung.

admin.add_view(ModelView(Post))  # Register a view (BaseModelView, CustomView, and so on)
admin.mount_to(app)  # Mount the admin onto your Starlette or FastAPI app

Views registrieren

Verwenden Sie add_view, um Komponenten zu Ihrem Admin-Dashboard hinzuzufügen. Die Methode akzeptiert entweder eine View-Instanz oder eine View-Klasse, und Sie können Model Views, benutzerdefinierte Seiten, Dropdown-Menüs und externe Links registrieren.

Die Anwendung mounten

Nachdem Sie alle Ihre Views registriert haben, rufen Sie mount_to(app) genau einmal auf, um den Admin an Ihre Starlette- oder FastAPI-Anwendung anzuhängen. Dieser Schritt finalisiert die Routing- und Sicherheitskonfiguration.

admin.app  # Raises RuntimeError: not mounted yet

admin.mount_to(app)
admin.app  # Returns the mounted sub-application

admin.add_view(ModelView(Comment))  # Raises RuntimeError: already mounted

Wie geht es weiter

• Security: Der secret_key, CSRF sowie die Export- und Import-Limits.
• Authentication: Die Einbindung des auth_provider.
• Multiple Admin Instances: Den Betrieb mehrerer Admin-Instanzen in derselben Anwendung.