FastAPI-Admin 项目启动与配置教程

1. 项目目录结构及介绍

FastAPI-Admin 是一个基于 FastAPI 的后台管理系统的开源项目。以下是项目的目录结构及其简要说明：

fastapi-admin/
├── app/                       # 应用程序核心代码目录
│   ├── api/                   # API相关模块
│   │   ├── __init__.py
│   │   ├── dependencies/      # 依赖注入模块
│   │   ├── endpoints/         # API端点模块
│   │   └── schemas/           # Pydantic模式定义
│   ├── auth/                  # 认证相关模块
│   ├── core/                  # 核心配置和工具模块
│   ├── db/                    # 数据库相关模块
│   ├── main.py                # 应用启动文件
│   └── settings/              # 配置模块
├── alembic/                   # 数据库迁移目录
│   └── versions/              # 迁移脚本
├── tests/                     # 测试模块目录
│   ├── __init__.py
│   ├── api/                   # API测试模块
│   └── conftest.py            # 测试配置文件
├── tools/                     # 工具脚本目录
├── requirements.txt           # 项目依赖
└── README.md                  # 项目说明文件

2. 项目的启动文件介绍

项目启动文件为 app/main.py，以下是该文件的主要内容和作用：

from fastapi import FastAPI
from app import settings

app = FastAPI()

@app.on_event("startup")
def startup_event():
    # 这里可以进行一些启动前的初始化操作，例如数据库连接等

@app.on_event("shutdown")
def shutdown_event():
    # 这里可以进行一些关闭前的清理操作，例如关闭数据库连接等

# 这里导入并注册API模块
from app.api.endpoints import some_endpoint

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

在这个文件中，我们创建了一个 FastAPI 实例，定义了一些事件处理器（如启动和关闭事件），并导入了 API 模块。最后，如果该文件作为主程序运行，我们使用 uvicorn ASGI 服务器来启动应用程序。

3. 项目的配置文件介绍

项目的配置文件位于 app/settings.py，该文件中定义了项目的配置信息，例如数据库连接字符串、端口号等。以下是配置文件的一个示例：

from pydantic import BaseSettings

class Settings(BaseSettings):
    API_TITLE: str = "FastAPI-Admin"
    API_VERSION: str = "0.1.0"
    PORT: int = 8000
    # 其他配置...

    class Config:
        env_file = ".env"

settings = Settings()

在 Settings 类中，我们定义了一些默认的配置值，并通过 env_file 参数指定了一个环境变量文件 .env，这样我们就可以通过环境变量来覆盖这些默认值。配置实例 settings 可以在应用程序的任何地方使用，以获取这些配置值。