FastAPI-Amis-Admin 项目教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00098/article/details/139851496

FastAPI-Amis-Admin 项目教程

fastapi-amis-admin FastAPI-Amis-Admin is a high-performance, efficient and easily extensible FastAPI admin framework. Inspired by django-admin, and has as many powerful functions as django-admin. 项目地址: https://gitcode.com/gh_mirrors/fa/fastapi-amis-admin

1. 项目的目录结构及介绍

FastAPI-Amis-Admin 项目的目录结构如下：

fastapi-amis-admin/
├── demo/
│   ├── __init__.py
│   └── main.py
├── docs/
│   ├── README.md
│   └── README.zh.md
├── fastapi_amis_admin/
│   ├── __init__.py
│   ├── admin/
│   ├── amis/
│   ├── crud/
│   └── models/
├── tests/
│   ├── __init__.py
│   └── test_main.py
├── .gitignore
├── LICENSE
├── README.md
├── README.zh.md
├── pdm.lock
└── pyproject.toml

目录结构介绍

demo/: 包含项目的演示代码，main.py 是项目的启动文件。
docs/: 包含项目的文档，README.md 和 README.zh.md 分别是英文和中文的介绍文档。
fastapi_amis_admin/: 项目的核心代码目录，包含 admin、amis、crud 和 models 等子模块。
tests/: 包含项目的测试代码，test_main.py 是主要的测试文件。
.gitignore: Git 忽略文件配置。
LICENSE: 项目的开源许可证文件。
README.md: 项目的英文介绍文档。
README.zh.md: 项目的中文介绍文档。
pdm.lock: 项目依赖管理文件。
pyproject.toml: 项目的配置文件。

2. 项目的启动文件介绍

项目的启动文件位于 demo/main.py，以下是该文件的主要内容：

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'))

# 挂载 AdminSite 实例
site.mount_app(app)

if __name__ == '__main__':
    import uvicorn
    uvicorn.run(app)

启动文件介绍

FastAPI 应用创建: 使用 FastAPI() 创建一个 FastAPI 应用实例 app。
AdminSite 实例创建: 使用 AdminSite 类创建一个管理站点实例 site，并传入数据库配置。
挂载 AdminSite 实例: 使用 site.mount_app(app) 将管理站点挂载到 FastAPI 应用上。
启动应用: 使用 uvicorn.run(app) 启动 FastAPI 应用。

3. 项目的配置文件介绍

项目的配置文件是 pyproject.toml，以下是该文件的主要内容：

[tool.pdm]
package = ["fastapi_amis_admin"]

[tool.pdm.dev-dependencies]
pre-commit = "*"

[tool.pdm.scripts]
test = "pytest tests"

[tool.pdm.version]
source = "scm"

[tool.pdm.build]
package-dir = "fastapi_amis_admin"