FastAPI-Admin 快速入门教程

FastAPI-Admin 快速入门教程

fastapi-admin项目地址:https://gitcode.com/gh_mirrors/fas/fastapi-admin

本教程将引导您了解并安装基于FastAPI和TortoiseORM的管理后台框架——FastAPI-Admin。我们将涵盖项目的基本目录结构、启动文件以及配置文件的介绍。

1. 项目目录结构及介绍

FastAPI-Admin的典型目录结构如下：

your_project/
├── main.py            # 应用入口文件
├── app.py              # FastAPI应用实例
├── config.py           # 配置文件
├── db                  # 数据库相关文件夹
│   ├── models.py       # 模型定义
├── admin               # FastAPI-Admin配置和资源注册
│   ├── init_admin.py    # 初始化管理界面
│   └── resources.py     # 资源类定义
└── requirements.txt     # 依赖包列表

• main.py: 应用的入口文件，通常用于设置日志、中间件和启动FastAPI服务器。
• app.py: 包含FastAPI应用实例，用于挂载FastAPI-Admin子应用。
• config.py: 配置文件，存储连接数据库和FastAPI-Admin的参数。
• db/models.py: 数据模型的定义，使用TortoiseORM进行数据库操作。
• admin: FastAPI-Admin的配置和资源文件，包含初始化管理和资源注册的代码。
• requirements.txt: 项目所需的Python包列表。

2. 项目启动文件介绍

以main.py为例，这是启动FastAPI应用的关键文件：

from fastapi import FastAPI
from fastapi_admin.app import app as admin_app
from your_project.config import settings  # 引入配置文件
from your_project.db.models import User  # 引入数据模型

app = FastAPI()

# 挂载FastAPI-Admin子应用
app.mount("/admin", admin_app)

if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app, host=settings.HOST, port=settings.PORT)

这里的app.mount()方法用于将FastAPI-Admin应用挂载到FastAPI主应用的/admin路径下。

3. 项目的配置文件介绍

在config.py中，您可以定义与FastAPI-Admin相关的环境变量，例如数据库连接和认证设置：

class Settings(BaseSettings):
    DATABASE_URL: str
    REDIS_URL: str
    ADMIN_USERNAME: str
    ADMIN_PASSWORD: str
    HOST: str = "0.0.0.0"
    PORT: int = 8000


settings = Settings()

这里定义了一个名为Settings的类，继承自BaseSettings（可能来自pydantic或类似的库）。您可以根据实际需求添加更多配置项，如日志级别、错误处理等。

在main.py中引入配置文件，然后在需要的地方使用settings对象来访问这些配置。

完成上述步骤后，您就可以通过运行main.py来启动带有FastAPI-Admin后台的Web服务了。记得根据您的环境配置好config.py中的参数。

这样，您就有了一个基本的FastAPI-Admin项目模板，可以根据自己的业务需求扩展和定制。祝您开发愉快！

fastapi-admin项目地址:https://gitcode.com/gh_mirrors/fas/fastapi-admin