fastapi-amis-admin是一个拥有高性能,高效率,易拓展的fastapi管理后台框架.
启发自Django-Admin,并且拥有不逊色于Django-Admin的强大功能.
fastapi-amis-admin
是一个基于fastapi
+amis
开发的高性能并且高效率 web-admin
框架,使用 Python 3.7+ 并基于标准的 Python 类型提示.
fastapi-amis-admin
开发的初衷是为了完善fastapi
应用生态, 为fastapi
web应用程序快速生成一个可视化管理后台.
性能极高:基于FastAPI, 可享受FastAPI
的全部优势.
效率更快:完善的编码类型提示, 代码可重用性更高.
支持异步和同步混合编写: ORM
基于SQLModel
+Sqlalchemy
, 可自由定制数据库类型, 支持同步及异步模式, 可拓展性强.
前后端分离: 前端由Amis
渲染, 后端接口由fastapi-amis-admin
自动生成, 接口可重复利用.
可拓展性强: 后台页面支持Amis
页面及普通html
页面,开发者可以很方便的自由定制界面.
自动生成API文档: 由FastAPI
自动生成接口文档,方便开发者调试,以及接口分享.
SQLAlchemy
和Pydantic
的所有功能)fastapi-amis-admin
由三部分核心模块组成,其中amis
, crud
可作为独立模块单独使用,admin
基于前者共同构建.
amis
: 基于baidu amis
的pydantic
数据模型构建库,用于快速生成/解析amis
json
数据.crud
: 基于FastAPI
+Sqlalchemy
, 用于快速构建Create,Read,Update,Delete通用API接口.admin
: 启发自Django-Admin
, 结合amis
+crud
, 用于快速构建Web Admin
管理后台.pip install fastapi_amis_admin
sqlmodel
目前暂不支持sqlalchemy 2.0+
, 如果你使用sqlalchemy 2.0+
创建模型, 则不可同时使用sqlmodel
.fastapi-amis-admin>=0.6.0
版本以后,sqlmodel
不再是必须依赖库,如果你使用sqlmodel
创建模型, 可以通过以下命令安装.pip install fastapi_amis_admin[sqlmodel]
from fastapi import FastAPI
from fastapi_amis_admin.admin.settings import Settings
from fastapi_amis_admin.admin.site import AdminSite
# 创建FastAPI应用
app = FastAPI()
# 创建AdminSite实例
site = AdminSite(settings=Settings(database_url_async='sqlite+aiosqlite:///amisadmin.db'))
# 挂载后台管理系统
site.mount_app(app)
if __name__ == '__main__':
import uvicorn
uvicorn.run(app)
SQLModel
模型的、SQLAlchemy
模型、SQLAlchemy 2.0
模型SQLModel
创建模型.from sqlmodel import SQLModel
from fastapi_amis_admin.models.fields import Field
class Base(SQLModel):
pass
# 创建SQLModel模型,详细请参考: https://sqlmodel.tiangolo.com/
class Category(SQLModel, table=True):
id: int = Field(default=None, primary_key=True, nullable=False)
name: str = Field(title='CategoryName', max_length=100, unique=True, index=True, nullable=False)
description: str = Field(default='', title='Description', max_length=255)
SQLAlchemy
创建模型.from sqlalchemy import Column, Integer, String
from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()
# 创建SQLAlchemy模型,详细请参考: https://docs.sqlalchemy.org/en/14/orm/tutorial.html
class Category(Base):
__tablename__ = 'category'
__pydantic_model__ = CategorySchema # 指定模型对应的Schema类.省略可自动生成,但是建议指定.
id = Column(Integer, primary_key=True, nullable=False)
name = Column(String(100), unique=True, index=True, nullable=False)
description = Column(String(255), default='')
SQLAlchemy 2.0
创建模型.from sqlalchemy import String
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
class Base(DeclarativeBase):
pass
# 创建SQLAlchemy 2.0模型,详细请参考: https://docs.sqlalchemy.org/en/20/orm/quickstart.html
class Category(Base):
__tablename__ = "category"
__pydantic_model__ = CategorySchema # 指定模型对应的Schema类.省略可自动生成,但是建议指定.
id: Mapped[int] = mapped_column(primary_key=True, nullable=False)
name: Mapped[str] = mapped_column(String(100), unique=True, index=True, nullable=False)
description: Mapped[str] = mapped_column(String(255), default="")
sqlalchemy
创建模型,建议同时创建一个对应的pydantic模型,并且设置orm_mode=True
.from pydantic import BaseModel, Field
class CategorySchema(BaseModel):
id: int = Field(default=None, primary_key=True, nullable=False)
name: str = Field(title="CategoryName")
description: str = Field(default="", title="CategoryDescription")
class Config:
orm_mode = True
from fastapi import FastAPI
from sqlmodel import SQLModel
from fastapi_amis_admin.admin.settings import Settings
from fastapi_amis_admin.admin.site import AdminSite
from fastapi_amis_admin.admin import admin
# 创建FastAPI应用
app = FastAPI()
# 创建AdminSite实例
site = AdminSite(settings=Settings(database_url_async='sqlite+aiosqlite:///amisadmin.db'))
# 注册ModelAdmin
@site.register_admin
class CategoryAdmin(admin.ModelAdmin):
page_schema = '分类管理'
# 配置管理模型
model = Category
# 挂载后台管理系统
site.mount_app(app)
# 创建初始化数据库表
@app.on_event("startup")
async def startup():
await site.db.async_run_sync(Base.metadata.create_all, is_session=False)
if __name__ == '__main__':
import uvicorn
uvicorn.run(app)
from typing import Any
from fastapi import FastAPI
from pydantic import BaseModel
from starlette.requests import Request
from fastapi_amis_admin.amis.components import Form
from fastapi_amis_admin.admin import admin
from fastapi_amis_admin.admin.settings import Settings
from fastapi_amis_admin.admin.site import AdminSite
from fastapi_amis_admin.crud.schema import BaseApiOut
from fastapi_amis_admin.models.fields import Field
# 创建FastAPI应用
app = FastAPI()
# 创建AdminSite实例
site = AdminSite(settings=Settings(database_url_async='sqlite+aiosqlite:///amisadmin.db'))
# 注册FormAdmin
@site.register_admin
class UserLoginFormAdmin(admin.FormAdmin):
page_schema = 'UserLoginForm'
# 配置表单信息, 可省略
form = Form(title='这是一个测试登录表单', submitText='登录')
# 创建表单数据模型
class schema(BaseModel):
username: str = Field(..., title='用户名', min_length=3, max_length=30)
password: str = Field(..., title='密码')
# 处理表单提交数据
async def handle(self, request: Request, data: BaseModel, **kwargs) -> BaseApiOut[Any]:
if data.username == 'amisadmin' and data.password == 'amisadmin':
return BaseApiOut(msg='登录成功!', data={'token': 'xxxxxx'})
return BaseApiOut(status=-1, msg='用户名或密码错误!')
# 挂载后台管理系统
site.mount_app(app)
if __name__ == '__main__':
import uvicorn
uvicorn.run(app)
# 安装命令行拓展
pip install fastapi_amis_admin[cli]
# 查看帮助
faa --help
# 初始化一个`FastAPI-Amis-Admin`项目
faa new project_name --init
# 初始化一个`FastAPI-Amis-Admin`应用
faa new app_name
# 快速运行项目
faa run
http://127.0.0.1:8000/admin/
in your browser:http://127.0.0.1:8000/admin/docs
in your browser:Amis-Admin-Theme-Editor
:FastAPI-Amis-Admin
的主题编辑器。
允许添加自定义css样式和应用主题,变量改变及时生效.FastAPI-User-Auth
: 一个简单而强大的FastAPI
用户RBAC
认证与授权库.FastAPI-Scheduler
: 一个基于APScheduler
的简单定时任务管理FastAPI
拓展库.FastAPI-Config
: 一个基于FastAPI-Amis-Admin
的可视化动态配置管理拓展包.FastAPI-Amis-Admin-Demo
: 一个FastAPI-Amis-Admin
应用程序示例.FastAPI-User-Auth-Demo
: 一个FastAPI-User-Auth
应用程序示例.fastapi-amis-admin
基于Apache2.0
开源免费使用,可以免费用于商业用途,但请在展示界面中明确显示关于FastAPI-Amis-Admin的版权信息.感谢以下开发者对 FastAPI-Amis-Admin 作出的贡献:
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。
1. 开源生态
2. 协作、人、软件
3. 评估模型