快速上手!如何在FastAPI中使用MYSQL构建强大的ADMIN后台?

517 阅读2分钟

一、集思广益

FastAPI操作数据库的文章,网上有很多。

FastAPI因其原生支持异步,且支持Pydantic标准格式校验,广泛受到开发者的青睐。

那么如何支持异步数据库?并继续支持Pydantic呢?

那么FastAPI能不能像Django那样支持 admin 后台呢?可以快捷的对数据库表进行CRUD呢?

二、SQLModel

在此,我们使用了 SQLModel

SQLModel 是一个库,用于通过 Python 代码和 Python 对象与SQL 数据库进行交互。它被设计为直观、易于使用、高度兼容和强大。

SQLModel基于 Python 类型注释,由PydanticSQLAlchemy提供支持。

主要特点是:

  • 编写直观:强大的编辑器支持。处处圆满。更少的调试时间。旨在易于使用和学习。阅读文档的时间更少。
  • 易于使用:它具有合理的默认值,并在底层做了很多工作以简化您编写的代码。
  • 兼容:它旨在与FastAPI、Pydantic 和 SQLAlchemy 兼容。
  • 可扩展:您拥有 SQLAlchemy 和 Pydantic 的所有功能。
  • 简短:最小化代码重复。单个类型注解可以完成很多工作。无需在 SQLAlchemy 和 Pydantic 中复制模型。

配置示例代码:db_config.py


from sqlalchemy.orm import declarative_base
from sqlmodel import create_engine


sqlite_file_name = "alert.db"
sqlite_url = f"sqlite:///{sqlite_file_name}"
# mysql or sqlite all is ok 
mysql_url = 'mysql+mysqlconnector://root:mysql@127.0.0.1:3306/alert_test_db'

engine = create_engine(mysql_url, echo=True)

Base = declarative_base()

模型示例代码:db_models.py

from typing import List, Optional

from sqlmodel import Field, Relationship, Session, SQLModel, create_engine


class HeroTeamLink(SQLModel, table=True):
    team_id: Optional[int] = Field(
        default=None, foreign_key="team.id", primary_key=True
    )
    hero_id: Optional[int] = Field(
        default=None, foreign_key="hero.id", primary_key=True
    )


class Team(SQLModel, table=True):
    id: Optional[int] = Field(default=None, primary_key=True)
    name: str = Field(index=True)
    headquarters: str

    heroes: List["Hero"] = Relationship(back_populates="teams", link_model=HeroTeamLink)


class Hero(SQLModel, table=True):
    id: Optional[int] = Field(default=None, primary_key=True)
    name: str = Field(index=True)
    secret_name: str
    age: Optional[int] = Field(default=None, index=True)

    teams: List[Team] = Relationship(back_populates="heroes", link_model=HeroTeamLink)


sqlite_file_name = "database.db"
sqlite_url = f"sqlite:///{sqlite_file_name}"

engine = create_engine(sqlite_url, echo=True)


def create_db_and_tables():
    SQLModel.metadata.create_all(engine)


def create_heroes():
    with Session(engine) as session:
        team_preventers = Team(name="Preventers", headquarters="Sharp Tower")
        team_z_force = Team(name="Z-Force", headquarters="Sister Margaret’s Bar")

        hero_deadpond = Hero(
            name="Deadpond",
            secret_name="Dive Wilson",
            teams=[team_z_force, team_preventers],
        )
        session.add(hero_deadpond)
        session.commit()


def main():
    create_db_and_tables()
    create_heroes()


if __name__ == "__main__":
    main()
    

三、fastapi-amis-admin

fastapi-amis-admin 是一个拥有高性能,高效率,易拓展的fastapi管理后台框架 启发自Django-Admin,并且拥有不逊色于Django-Admin的强大功能.

官网文档 http://docs.amis.work/

界面预览

浏览器打开:<http://127.0.0.1:8000/admin/>

image.png

amdin/doc预览

浏览器打开:http://127.0.0.1:8000/admin/docs :

快速使用 fastapi-amis-admin

安装

pip install fastapi_amis_admin

简单示例


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, debug=True)
    

更多高级用法