# fastapi_prod_templeate **Repository Path**: Wang_LaoSi/fastapi_prod_templeate ## Basic Information - **Project Name**: fastapi_prod_templeate - **Description**: No description available - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2024-11-29 - **Last Updated**: 2024-12-31 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # FastAPI Project Template 一个基于 FastAPI 的高性能异步 Web 框架模板，采用现代化的项目结构和最佳实践。 ## 特性 - 🚀 基于 FastAPI 的高性能异步框架 - 🔐 完整的认证和权限系统 - 📦 模块化的项目结构 - 🗄️ MySQL 数据库集成 - 📝 自动生成的 API 文档 - 🔄 中间件系统 - 🎯 依赖注入 - 🔍 请求上下文追踪 - 📊 统一的响应格式 - 🐳 Docker 支持 ## 项目结构 ``` app/ ├── api/ # API路由层 ├── core/ # 核心配置和功能 │ ├── config/ # 配置管理 │ ├── context/ # 请求上下文 │ ├── middleware/ # 中间件 │ └── security/ # 安全相关 ├── exceptions/ # 自定义异常 ├── models/ # 数据库模型 ├── schemas/ # 数据验证模型 ├── service/ # 业务逻辑层 ├── tasks/ # 异步任务 └── utils/ # 工具函数 ``` ## 快速开始 ### Docker 模式（推荐） #### 环境要求 - Docker & Docker Compose #### 一键启动所有服务： ```bash git clone https://gitee.com/Wang_LaoSi/fastapi_prod_templeate.git cd fastapi_prod_templeate cp .env.example .env.dev # 启动服务 docker-compose up -d # 查看服务状态 docker-compose ps # 查看应用日志 docker-compose logs -f app # 停止服务 docker-compose down ``` ### 传统模式 #### 环境要求 - Python 3.12+ - Redis - SQLite #### 安装依赖：克隆代码： ```bash git clone https://gitee.com/Wang_LaoSi/fastapi_prod_templeate.git ``` 进入项目目录： ```bash cd fastapi_prod_templeate ``` 创建虚拟环境： ```bash # 创建虚拟环境 python -m venv venv source venv/bin/activate # Linux/Mac venv\Scripts\activate # Windows # 安装依赖 pip install -r requirements.txt ``` 3. 配置环境变量： ```bash cp .env.example .env.dev # 编辑 .env.dev 文件配置数据库等信息 ``` 4. 运行应用： ```bash uvicorn app.main:app --reload --host 0.0.0.0 --port 8000 ``` ## 代码提交规范 1. 分支管理： - `main`: 主分支，用于生产环境 - `dev`: 开发分支，用于功能集成 - `feature/*`: 功能分支 - `hotfix/*`: 紧急修复分支 2. 提交信息格式： ``` ():