FastAPI Tortoise Architecture

作为 FastAPI 框架的一个基础项目，基于 python3.10 开发

特征

• FastAPI > 0.100.0
• Async design
• Restful API
• Tortoise-orm > 0.20.0
• Pydantic 2.0
• Docker
• ......

使用

Warning

此过程请格外注意端口占用情况, 特别是 8000, 3306, 6379...

1: 传统

1. 安装依赖项

   pip install -r requirements.txt

2. 创建一个数据库 ftm, 选择 utf8mb4 编码

3. 安装启动 redis

4. 在 backend/app/ 目录下创建一个 .env 文件

   cd backend/app/
   touch .env

5. 复制 .env.example 到 .env

   cp .env.example .env

6. 数据库迁移

   cd backend/app
   
   # 初始化配置
   aerich init -t migration.TORTOISE_ORM
   
   # 初始化数据库，生成迁移文件
   aerich init-db
   
   # 执行迁移
   aerich upgrade
   
   # 当更新数据库 model 后，执行下面两个命令进行迁移
   aerich migrate
   aerich upgrade

7. 执行 backend/app/main.py 文件启动服务

8. 浏览器访问: http://127.0.0.1:8000/api/v1/docs

---

2: docker

1. 进入 docker-compose.yml 文件所在目录，创建环境变量文件 .env

   dcd deploy/docker-compose/
   
   cp .env.server ../../backend/app/.env

2. 执行一键启动命令

   docker-compose up -d --build

3. 等待命令自动完成

4. 浏览器访问：http://127.0.0.1:8000/api/v1/docs

互动

WeChat / QQ

赞助

如果此项目能够帮助到你，你可以赞助作者一些咖啡豆表示鼓励：☕ Sponsor ☕

许可证

本项目根据 MIT 许可证的条款进行许可