Application

sqladmin.application.Admin 基类：BaseAdminView

管理员界面的主要入口。

用法

from fastapi import FastAPI
from sqladmin import Admin, ModelView

from mymodels import User  # SQLAlchemy 模型

app = FastAPI()
admin = Admin(app, engine)

class UserAdmin(ModelView, model=User):
    column_list = [User.id, User.name]

admin.add_view(UserAdmin)

__init__ 方法

__init__(app, engine=None, session_maker=None, base_url='/admin', title='Admin', logo_url=None, favicon_url=None, middlewares=None, debug=False, templates_dir='templates', authentication_backend=None)

参数：

名称	类型	描述	默认值
app	Starlette	Starlette 或 FastAPI 应用实例	必填
engine	ENGINE_TYPE	None	SQLAlchemy 引擎实例
session_maker	sessionmaker	'async_sessionmaker'	None
base_url	str	管理界面的基础 URL	'/admin'
title	str	管理界面的标题	'Admin'
logo_url	str	None	显示的 logo URL
favicon_url	str	None	显示的 favicon URL

---

sqladmin.application.BaseAdmin 实现管理员界面的基类。

警告： 这个类通常不应该直接使用。

views：list[BaseView | ModelView] 惰性加载获取 ModelView 和 BaseView 实例的列表。

返回值：

类型	描述
list[BaseView	ModelView]

add_view(view) 将 ModelView 或 BaseView 类添加到 Admin 中。 这是一个快捷方式，处理 add_model_view 和 add_base_view。

add_model_view(view) 将 ModelView 添加到 Admin 中。

用法

from sqladmin import Admin, ModelView

class UserAdmin(ModelView, model=User):
    pass

admin.add_model_view(UserAdmin)

add_base_view(view) 将 BaseView 添加到 Admin 中。

用法

from sqladmin import BaseView, expose

class CustomAdmin(BaseView):
    name = "自定义页面"
    icon = "fa-solid fa-chart-line"

    @expose("/custom", methods=["GET"])
    async def test_page(self, request: Request):
        return await self.templates.TemplateResponse(request, "custom.html")

admin.add_base_view(CustomAdmin)

---

sqladmin.application.action

装饰器，用于为 ModelView 函数添加自定义“操作”路由，并在管理面板中添加按钮来调用该操作。

当从管理面板中调用时，将传递以下查询参数：

• pks：选定对象主键的逗号分隔列表 - 可能为空。

参数：

名称	类型	描述	默认值
name	str	操作的唯一名称 - 应该是字母数字、短横线和下划线组成	必填
label	str	None	描述操作的可读文本
confirmation_message	str	None	操作前显示的确认消息
include_in_schema	bool	是否将该端点包含在 API 文档中	True
add_in_detail	bool	是否在模型详情页显示该操作	True
add_in_list	bool	是否在模型列表页显示该操作	True