https://github.com/pysuper/fastapi-template
现代化的Python Web后端框架，专注于高性能、可扩展性和开发效率
https://github.com/pysuper/fastapi-template
api async cache core docker jwt lb rbac services sqlalchemy
Last synced: about 1 month ago
JSON representation
现代化的Python Web后端框架，专注于高性能、可扩展性和开发效率
- Host: GitHub
- URL: https://github.com/pysuper/fastapi-template
- Owner: Pysuper
- License: mit
- Created: 2025-02-21T07:20:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-21T08:10:33.000Z (over 1 year ago)
- Last Synced: 2025-02-21T08:28:28.064Z (over 1 year ago)
- Topics: api, async, cache, core, docker, jwt, lb, rbac, services, sqlalchemy
- Language: Python
- Homepage:
- Size: 709 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: docs/README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Speedy Framework 文档
## 项目简介
Speedy Framework 是一个现代化的Python Web框架，提供了完整的企业级应用开发解决方案。框架采用模块化设计，支持异步编程，并集成了多种企业级特性。
## 技术栈
- Python 3.8+
- FastAPI
- SQLAlchemy
- Redis
- PostgreSQL
- Alembic
- Pydantic
- pytest
## 核心模块
### 基础设施
- [缓存管理](core/cache.md) - 提供多级缓存支持和缓存策略管理
- [日志管理](core/loge.md) - 统一的日志记录和管理功能
- [配置管理](core/config.md) - 多环境配置管理和动态配置支持
- [依赖注入](core/dependencies.md) - 灵活的依赖注入系统
### 数据处理
- [数据库](core/db.md) - 数据库连接和ORM支持
- [数据迁移](core/migrations.md) - 数据库迁移和版本控制
- [数据仓储](core/repositories.md) - 统一的数据访问层抽象
### 安全机制
- [安全模块](core/security.md) - 认证、授权和安全防护
- [RBAC权限](core/rbac.md) - 基于角色的访问控制系统
- [异常处理](core/exceptions.md) - 统一的异常处理机制
### 性能优化
- [性能增强](core/strong.md) - 性能优化和资源管理
- [监控模块](core/monitor.md) - 应用监控和性能分析
### 中间件和工具
- [中间件](core/middlewares.md) - 请求处理中间件
- [拦截器](core/interceptor.md) - 请求和响应拦截器
- [工具函数](core/utils.md) - 通用工具和辅助函数
- [装饰器](core/decorators.md) - 功能增强装饰器
### 业务支持
- [服务层](core/services.md) - 业务逻辑服务层
- [任务处理](core/tasks.md) - 异步任务和调度管理
- [待办功能](core/todo.md) - 任务管理和待办系统
### 集成与扩展
- [第三方集成](core/third.md) - 外部服务和系统集成
- [国际化](core/I18n.md) - 多语言和本地化支持
- [响应处理](core/response.md) - 统一的响应格式化
- [常量定义](core/constants.md) - 系统常量和枚举值
## 快速开始
1. 安装依赖
```bash
pip install -r requirements.txt
```
2. 配置环境
```bash
cp .env.example .env
# 编辑 .env 文件设置必要的环境变量
```
3. 初始化数据库
```bash
python manage.py migrate
```
4. 运行开发服务器
```bash
python manage.py runserver
```
## 开发指南
### 代码规范
- 遵循PEP 8规范
- 使用类型注解
- 编写单元测试
- 添加文档注释
### 开发流程
1. 创建功能分支
2. 编写代码和测试
3. 提交代码审查
4. 合并到主分支
### 测试
```bash
# 运行单元测试
pytest
# 运行覆盖率测试
pytest --cov=app tests/
```
## 部署
### 环境要求
- Python 3.8+
- PostgreSQL 12+
- Redis 6+
- Nginx
### 部署步骤
1. 准备环境
2. 配置服务器
3. 部署应用
4. 启动服务
## 维护和支持
### 问题报告
- 使用 GitHub Issues 报告问题
- 提供详细的复现步骤
- 附加相关的日志信息
### 贡献指南
- Fork 项目
- 创建特性分支
- 提交变更
- 创建 Pull Request
## 版本历史
### v1.0.0 (2024-01-05)
- 初始版本发布
- 核心功能实现
- 基础文档完善
## 许可证
本项目采用 MIT 许可证 - 详见 [LICENSE](../LICENSE) 文件