【亲测免费】 FastAPI 后端模板项目教程

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

FastAPI 后端模板项目的目录结构如下：

FastAPI-Backend-Template/
├── app/
│   ├── __init__.py
│   ├── main.py
│   ├── config/
│   │   ├── __init__.py
│   │   ├── settings.py
│   ├── api/
│   │   ├── __init__.py
│   │   ├── endpoints/
│   │   │   ├── __init__.py
│   │   │   ├── example.py
│   ├── core/
│   │   ├── __init__.py
│   │   ├── security.py
│   ├── db/
│   │   ├── __init__.py
│   │   ├── session.py
│   ├── models/
│   │   ├── __init__.py
│   │   ├── example_model.py
│   ├── schemas/
│   │   ├── __init__.py
│   │   ├── example_schema.py
├── tests/
│   ├── __init__.py
│   ├── test_main.py
├── .env
├── .gitignore
├── README.md
├── requirements.txt
├── Dockerfile
├── docker-compose.yml

目录结构介绍

• app/: 项目的主要代码目录。
  • __init__.py: 使 app 目录成为一个 Python 包。
  • main.py: 项目的入口文件。
  • config/: 配置文件目录。
    • settings.py: 配置文件，包含项目的各种配置参数。
  • api/: API 相关代码目录。
    • endpoints/: API 端点目录。
      • example.py: 示例 API 端点。
  • core/: 核心功能目录。
    • security.py: 安全相关功能，如认证和授权。
  • db/: 数据库相关代码目录。
    • session.py: 数据库会话管理。
  • models/: 数据库模型目录。
    • example_model.py: 示例数据库模型。
  • schemas/: Pydantic 模型目录。
    • example_schema.py: 示例 Pydantic 模型。
• tests/: 测试代码目录。
  • test_main.py: 主测试文件。
• .env: 环境变量文件。
• .gitignore: Git 忽略文件。
• README.md: 项目说明文档。
• requirements.txt: 项目依赖文件。
• Dockerfile: Docker 配置文件。
• docker-compose.yml: Docker Compose 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 app/main.py。该文件主要包含 FastAPI 应用的实例化和基本配置。

from fastapi import FastAPI
from app.api.endpoints import example

app = FastAPI()

app.include_router(example.router)

@app.get("/")
def read_root():
    return {"message": "Hello World"}

启动文件介绍

• from fastapi import FastAPI: 导入 FastAPI 类。
• from app.api.endpoints import example: 导入示例 API 端点。
• app = FastAPI(): 创建 FastAPI 应用实例。
• app.include_router(example.router): 将示例 API 端点路由包含到应用中。
• @app.get("/"): 定义根路径的 GET 请求处理函数。

3. 项目的配置文件介绍

项目的配置文件位于 app/config/settings.py。该文件主要包含项目的各种配置参数。

from pydantic import BaseSettings

class Settings(BaseSettings):
    DATABASE_URL: str = "sqlite:///./sql_app.db"
    SECRET_KEY: str = "your-secret-key"
    ALGORITHM: str = "HS256"
    ACCESS_TOKEN_EXPIRE_MINUTES: int = 30

settings = Settings()

配置文件介绍

• from pydantic import BaseSettings: 导入 Pydantic 的 BaseSettings 类。
• class Settings(BaseSettings):