Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fmw666/fastapi-builder
🚀 这是一个用于快速构建 fastapi 项目基础框架的工具，您可以直接在上面着手开发您的 fastapi 项目.
https://github.com/fmw666/fastapi-builder
build build-tool command-line fastapi
Last synced: 4 days ago
JSON representation
🚀 这是一个用于快速构建 fastapi 项目基础框架的工具，您可以直接在上面着手开发您的 fastapi 项目.
- Host: GitHub
- URL: https://github.com/fmw666/fastapi-builder
- Owner: fmw666
- License: mit
- Created: 2021-11-24T11:48:57.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-06T10:12:31.000Z (about 1 month ago)
- Last Synced: 2025-01-30T07:08:51.013Z (12 days ago)
- Topics: build, build-tool, command-line, fastapi
- Language: Python
- Homepage:
- Size: 230 KB
- Stars: 39
- Watchers: 3
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 「 FastAPI Builder V2 」
> 💡 **fastapi 项目构建器. 一款帮助您快速构建 fastapi 项目的工具.**
fastapi-builder 是一个基于 FastAPI 框架的快速 Web 应用程序开发的工具箱。它提供了一组现成的工具和组件，可以帮助您快速构建具有良好结构和可维护性的 FastAPI Web 应用程序。其目的是提供一个一站式的解决方案，以加速快速原型开发和生产部署。
+ ***[特性](#-特性)***
+ ***[TODO](#-todo)***
+ ***[快速开始](#-快速开始)***
+ ***[项目结构](#-项目结构)***
+ ***[特别感谢](#-特别感谢)***
+ ***[许可证](#-许可证)***
## 💬 特性
+ 🔥 一键生成可定制的应用程序模块，支持热更新，并提供完整的 CRUD 接口。
+ 灵感来源于 Django 的项目基础命令。
+ 支持创建可自定义的完整项目结构。
+ 自动生成项目结构，简化初始化过程。
+ 对数据库操作进行封装，简化管理流程。
+ 支持多种数据库，包括 MySQL。
+ 提供 Dockerfile 和 pre-commit 钩子等可选配置。
+ 管理虚拟环境，简化环境搭建和依赖管理。
## 🎯 TODO
+ [ ] 持续完善项目框架代码
+ [ ] 持续完善项目文档
+ [x] 优化 requirements.txt
+ [ ] 提供英文文档版本
+ [ ] 提供 PostgreSQL 数据库支持
+ [x] 提供完整的 run 方法
+ [x] 内置 Alembic 数据迁移管理
+ [x] 提供运行环境检查
+ [x] 提供 FastAPI venv 命令，管理虚拟环境
+ [x] 针对 Linux 和 Mac 环境提供支持
+ [x] 生成 app 时，自动注入到 project 中（路由管理分配）
## 🚀 快速开始
安装 `fastapi-builder` 项目：
```sh
pip install fastapi-builder
```
查看项目版本：
```sh
fastapi --version
```
项目帮助：
```sh
fastapi --help
fastapi startproject --help
```
创建 `fastapi` 项目：
```sh
fastapi startproject [name]
# or 带有交互选择
fastapi startproject [name] --interactive
```
创建 `fastapi` 应用：
```sh
fastapi startapp [name]
```
运行 `fastapi` 项目：
```sh
fastapi run
```
通过访问 `http://127.0.0.1:8000/docs` 以确保 fastapi 服务正常运行.
## 📁 项目结构
```c
.
├── alembic/ - 数据库迁移工具
├── api/ - web 相关（路由、认证、请求、响应）.
│ ├── errors/ - 定义错误处理方法.
│ │ ├── http_error.py - http 错误处理方法
│ │ │── validation_error.py - 验证错误处理方法
│ ├── routes/ - web routes 路由.
│ │ ├── api.py - 总路由接口
│ │ └── authentication.py - 认证相关（登录、注册）路由
├── apps/ - 子应用.
│ ├── app_user/ - user 应用.
│ │ ├── api.py - 提供 user 接口方法
│ │ ├── doc.py - 提供 user Swagger UI 文档
│ │ ├── field.py - 提供 user pydantic 验证字段
│ │ ├── model.py - 提供 user 表模型
│ │ └── schema.py - 提供 user pydantic 结构模型
│ ├── ... - 其他应用.
├── core/ - 项目核心配置, 如: 配置文件, 事件句柄, 日志.
│ ├── e/ - 错误处理包.
│ │ ├── __init__.py
│ │ ├── codes.py - 错误码定义
│ │ └── messages.py - 错误消息定义
│ ├── .env - 配置文件.
│ ├── config.py - 解析配置文件, 用于其他文件读取配置.
│ ├── events.py - 定义 fastapi 事件句柄.
│ ├── logger.py - 定义项目日志方法.
├── db/ - 数据库相关.
│ ├── base.py - 导入所有应用 model.
│ ├── database.py - sqlalchemy 方法应用.
│ ├── errors.py - 数据库相关错误异常.
├── lib/ - 自定义库
│ ├── jwt.py - 用户认证 jwt 方法.
│ ├── security.py - 加密相关方法.
├── logs/ - 日志文件目录.
├── middleware/ - 项目中间件.
│ ├── logger.py - 请求日志处理.
├── models/ - sqlalchemy 基础模型相关
│ ├── base.py - sqlalchemy declarative Base 表模型.
│ └── mixins.py - mixin 抽象模型定义.
├── schemas/ - pydantic 结构模型相关.
│ ├── base.py - pydantic 结构模型基础类.
│ ├── jwt.py - jwt 相关结构模型.
│ ├── response.py - 响应模型封装.
├── utils/ - 工具类.
│ ├── dbmanager.py - 数据库管理服务.
│ ├── docs.py - fastapi docs 文档自定义.
├── .flake8 - pep8 规范.
├── .pre-commit-config.yaml - pre-commit 配置文件.
├── alembic.ini - alembic 数据库迁移工具配置文件.
├── docker-compose.yaml - docker 配置.
├── Dockerfile - dockfile 文件.
├── .fastapi-builder.ini - fastapi-builder 配置文件.
├── LICENSE - 许可证信息.
├── main.py - fastapi application 创建和配置.
├── pyproject.toml - poetry 需求模块信息.
├── README.md - 项目说明文档.
├── requirements.txt - pip 需求模块信息.
└── setup.cfg - pre-commit 配置文件.
```
## ⚡ 特别感谢
项目配置生成及 questionary 内容基于项目：
fastapi 项目基础框架参考：
## 🚩 许可证
项目根据麻省理工学院的许可条款授权.