FastAPI + React 项目教程

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

fastapi-react-project/
├── assets/
├── scripts/
├── {{cookiecutter.project_slug}}/
│   ├── app/
│   │   ├── api/
│   │   ├── core/
│   │   ├── db/
│   │   ├── models/
│   │   ├── schemas/
│   │   ├── services/
│   │   ├── static/
│   │   ├── templates/
│   │   ├── __init__.py
│   │   ├── main.py
│   │   ├── config.py
│   │   ├── dependencies.py
│   │   ├── exceptions.py
│   │   ├── middleware.py
│   │   ├── routes.py
│   │   ├── utils.py
│   ├── tests/
│   ├── .gitignore
│   ├── CONTRIBUTING.md
│   ├── LICENSE
│   ├── README.md
│   ├── cookiecutter.json
│   ├── Dockerfile
│   ├── docker-compose.yml
│   ├── requirements.txt
│   ├── setup.py

目录结构介绍

• assets/: 存放静态资源文件。
• scripts/: 存放脚本文件。
• {{cookiecutter.project_slug}}/: 项目主目录。
  • app/: 应用主目录。
    • api/: API 路由和处理函数。
    • core/: 核心配置和功能。
    • db/: 数据库相关文件。
    • models/: 数据库模型。
    • schemas/: Pydantic 模型。
    • services/: 业务逻辑服务。
    • static/: 静态文件。
    • templates/: 模板文件。
    • main.py: 项目启动文件。
    • config.py: 配置文件。
    • dependencies.py: 依赖注入。
    • exceptions.py: 异常处理。
    • middleware.py: 中间件。
    • routes.py: 路由定义。
    • utils.py: 工具函数。
  • tests/: 测试文件。
  • .gitignore: Git 忽略文件。
  • CONTRIBUTING.md: 贡献指南。
  • LICENSE: 许可证。
  • README.md: 项目说明。
  • cookiecutter.json: Cookiecutter 配置文件。
  • Dockerfile: Docker 配置文件。
  • docker-compose.yml: Docker Compose 配置文件。
  • requirements.txt: Python 依赖包。
  • setup.py: 安装脚本。

2. 项目的启动文件介绍

main.py

from fastapi import FastAPI
from app.api import api_router
from app.core import settings

app = FastAPI(title=settings.PROJECT_NAME, openapi_url=f"{settings.API_V1_STR}/openapi.json")

app.include_router(api_router, prefix=settings.API_V1_STR)

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

• FastAPI 实例化并配置项目名称和 OpenAPI URL。
• 包含 API 路由器。
• 使用 uvicorn 启动应用。

3. 项目的配置文件介绍

config.py

from pydantic import BaseSettings

class Settings(BaseSettings):
    PROJECT_NAME: str = "FastAPI-React Project"
    API_V1_STR: str = "/api/v1"
    SECRET_KEY: str = "super_secret"
    SQLALCHEMY_DATABASE_URI: str = "postgresql://postgres:password@db:5432/app"
    SUPERUSER_EMAIL: str = "[e-mail]"
    SUPERUSER_PASSWORD: str = "password"

settings = Settings()

• BaseSettings 用于环境变量和默认值。
• 配置项目名称、API 版本路径、密钥、数据库 URI 和超级用户信息。

以上