क्विकस्टार्ट

मिनटों में एक ब्लॉग के लिए पूर्ण कार्यशील CRUD एडमिन इंटरफ़ेस बनाएँ, जिसमें ऑटो-जनरेटेड फ़ॉर्म, लिस्ट, खोज, इंपोर्ट और एक्सपोर्ट सीधे आपके डेटा मॉडल से संचालित होते हैं।

इंस्टॉलेशन

आवश्यक पैकेज को अपनी पसंदीदा पैकेज मैनेजर से इंस्टॉल करें:

pip install starlette-admin sqlalchemy "fastapi[standard]"

uv add starlette-admin sqlalchemy "fastapi[standard]"

पूर्ण उदाहरण

main.py नाम की फ़ाइल बनाएँ और उसमें निम्नलिखित कोड जोड़ें:

from contextlib import asynccontextmanager
from datetime import datetime, timezone

from fastapi import FastAPI
from sqlalchemy import create_engine
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
from starlette_admin.contrib.sqla import Admin, ModelView

engine = create_engine("sqlite:///blog.db", connect_args={"check_same_thread": False})


class Base(DeclarativeBase):
    pass


class Post(Base):
    __tablename__ = "posts"

    id: Mapped[int] = mapped_column(primary_key=True)
    title: Mapped[str]
    content: Mapped[str]
    published: Mapped[bool] = mapped_column(default=False)
    created_at: Mapped[datetime] = mapped_column(
        default=lambda: datetime.now(timezone.utc)
    )


class PostView(ModelView):
    fields = ["id", "title", "content", "published", "created_at"]
    searchable_fields = ("title", "content")


@asynccontextmanager
async def lifespan(app: FastAPI):
    Base.metadata.create_all(engine)
    yield


# Note: This can also be replaced by Starlette(lifespan=lifespan)
app = FastAPI(lifespan=lifespan)

admin = Admin(engine, title="Blog Admin", secret_key="change-me")
admin.add_view(PostView(Post, icon="fa fa-newspaper"))
admin.mount_to(app)

एप्लिकेशन चलाएँ

डेवलपमेंट सर्वर शुरू करें:

fastapi dev

uv run -- fastapi dev

ब्राउज़र खोलें और http://127.0.0.1:8000/admin पर जाएँ।

साइडबार में Posts चुनें, फिर Create चुनें। अब आप पेजिनेटेड लिस्ट, डिटेल, create, edit और delete पेजों तक पहुँच सकते हैं। यह सिस्टम आपकी मॉडल परिभाषा से इन सभी इंटरफ़ेस को स्वतः जनरेट करता है।

यह कैसे काम करता है

निम्नलिखित सेक्शन एप्लिकेशन के कोर कंपोनेंट समझाते हैं।

मॉडल

class Post(Base):
    __tablename__ = "posts"

    id: Mapped[int] = mapped_column(primary_key=True)
    title: Mapped[str]
    content: Mapped[str]
    published: Mapped[bool] = mapped_column(default=False)
    created_at: Mapped[datetime] = mapped_column(
        default=lambda: datetime.now(timezone.utc)
    )

यह कोड स्टैंडर्ड SQLAlchemy 2.0 का उपयोग करता है। starlette-admin पैकेज इन एट्रिब्यूट्स पर मैप किए गए कॉलम मेटाडेटा को पढ़कर यह तय करता है कि कौन सा HTML इनपुट जनरेट करना है। उदाहरण के लिए, यह str के लिए टेक्स्ट इनपुट, bool के लिए चेकबॉक्स और datetime के लिए डेटाटाइम पिकर बनाता है।

व्यू

class PostView(ModelView):
    fields = ["id", "title", "content", "published", "created_at"]
    searchable_fields = ("title", "content")

PostView इस रिसोर्स के लिए केंद्रीय ऑब्जेक्ट के रूप में कार्य करता है। fields एट्रिब्यूट यह नियंत्रित करता है कि लिस्ट और फ़ॉर्म में कौन से कॉलम दिखें, जबकि searchable_fields सर्च बार को सक्षम करता है। एडमिन डैशबोर्ड में Post कैसा दिखे और कैसे व्यवहार करे, इसका पूरा कॉन्फ़िगरेशन इसी एक क्लास में रहता है।

Admin

admin = Admin(engine, title="Blog Admin", secret_key="change-me")
admin.add_view(PostView(Post, icon="fa fa-newspaper"))
admin.mount_to(app)

Admin क्लास डेटाबेस इंजन को यूज़र इंटरफ़ेस से जोड़ती है।

• add_view आपके व्यू को साइडबार में रजिस्टर करता है। वैकल्पिक icon पैरामीटर कोई भी मान्य Font Awesome क्लास स्वीकार करता है।
• mount_to एडमिन एप्लिकेशन को /admin पाथ पर आपके FastAPI या Starlette एप्लिकेशन से जोड़ता है।

दूसरा मॉडल जोड़ें

आप असीमित संख्या में मॉडल रजिस्टर कर सकते हैं। उदाहरण के लिए, Tag मॉडल और उसका संबंधित व्यू जोड़ने के लिए, क्लास परिभाषित करें और add_view को फिर से कॉल करें:

class Tag(Base):
    __tablename__ = "tags"

    id: Mapped[int] = mapped_column(primary_key=True)
    name: Mapped[str]


class TagView(ModelView):
    fields = ["id", "name"]
    searchable_fields = ("name",)


admin.add_view(PostView(Post, icon="fa fa-newspaper"))
admin.add_view(TagView(Tag, icon="fa fa-tag"))

साइडबार में Posts और Tags दोनों को देखने के लिए ब्राउज़र विंडो को रिफ़्रेश करें। अब प्रत्येक रिसोर्स में अपनी पूर्ण कार्यशील लिस्ट, create, edit और delete पेज मौजूद हैं।

अगले चरण

• अवधारणाएँ: यहाँ पेश की गई अवधारणाओं की शब्दावली जानें ताकि उपयोगकर्ता गाइड में बेहतर ढंग से नेविगेट कर सकें।
• Admin: ब्रांडिंग, थीमिंग, प्रमाणीकरण, सुरक्षा और अंतर्राष्ट्रीयकरण सहित Admin(...) के सभी विकल्प देखें।
• व्यूज़: अपनी डेटा प्रस्तुति को अनुकूलित करने के लिए उपलब्ध हर ModelView कॉन्फ़िगरेशन विकल्प देखें।