Full-Stack FastAPI + PostgreSQL 项目启动与配置教程

一、项目目录结构及介绍

本项目是基于 FastAPI 和 PostgreSQL 构建的全栈项目。以下是项目的目录结构及其说明：

full-stack-fastapi-postgresql/
│
├── app/                        # 应用程序主目录
│   ├── api/                    # API相关模块
│   │   ├── dependencies/       # 依赖注入模块
│   │   ├── endpoints/          # API端点模块
│   │   └── models/             # 数据模型模块
│   │
│   ├── core/                   # 核心配置和工具模块
│   │   ├── config/             # 配置模块
│   │   └── security/           # 安全相关模块
│   │
│   ├── db/                     # 数据库操作模块
│   │   ├── base_class/         # 数据库基类
│   │   ├── models/             # 数据库模型
│   │   └── schemas/            # 数据库模式
│   │
│   ├── main.py                 # 应用程序入口文件
│   └── tests/                  # 测试模块
│
├── alembic/                    # 数据库迁移目录
│   └── versions/               # 迁移版本文件
│
├── tests/                      # 测试目录
│   ├── conftest.py             # 测试配置文件
│   └── test_api/               # API测试模块
│
├── tools/                      # 工具脚本目录
│   └── init_db.py              # 初始化数据库脚本
│
├── requirements.txt            # 项目依赖文件
└── README.md                   # 项目说明文件

• app/: 项目的主要应用程序目录，包含了所有的业务逻辑。
• api/: 包含所有与API相关的代码。
• core/: 包含项目的核心配置，如数据库配置、安全设置等。
• db/: 数据库相关的模块，包括数据模型和数据库操作。
• main.py: 应用的入口文件，用于启动 FastAPI 应用。
• tests/: 测试相关的代码和配置。
• alembic/: 用于数据库版本控制和迁移。
• tools/: 放置一些辅助性工具脚本，例如数据库初始化脚本。

二、项目的启动文件介绍

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

from fastapi import FastAPI
from app.core.config import settings
from app.db.session import Base, engine
from app.api.endpoints import urlpatterns

# 初始化数据库
Base.metadata.create_all(bind=engine)

app = FastAPI(title=settings.PROJECT_NAME, version=settings.PROJECT_VERSION)

# 添加路由
for url in urlpatterns:
    app.add_api_route(url.path, url.endpoints, **url.options)

• 首先，从配置文件中导入设置。
• 然后，使用 SQLAlchemy 的 create_all 方法创建数据库表。
• 接着，创建一个 FastAPI 实例，并为其设置标题和版本。
• 最后，循环添加 API 路由。

三、项目的配置文件介绍

项目的配置文件位于 app/core/config.py，以下是配置文件的主要内容：

from pydantic import BaseSettings
from typing import Any, Dict, List, Optional

class Settings(BaseSettings):
    PROJECT_NAME: str = "FastAPI Project"
    PROJECT_VERSION: str = "0.1.0"
    DATABASE_URL: Optional[str] = "postgresql://username:password@localhost:5432/dbname"

    class Config:
        env_file: str = ".env"

settings = Settings()

• 使用 Pydantic 的 BaseSettings 类来定义配置。
• 包含了项目名称、版本和数据库连接字符串等配置项。
• 通过 env_file 指定环境变量文件，以便可以从 .env 文件中加载配置。

通过以上三个部分，可以了解到本开源项目的目录结构、启动文件及其配置文件的基本情况，为后续的项目运行和开发奠定了基础。