fastapi-ignite 的安装和配置教程

项目基础介绍

fastapi-ignite 是一个为现代 Web 后端开发准备的、开箱即用的 FastAPI 项目模板。它提供了一套完整的功能，使得开发者能够快速启动和运行一个具有生产级别的 FastAPI 应用程序。

本项目主要使用 Python 语言开发。

项目使用的关键技术和框架

fastapi-ignite 使用以下技术和框架构建：

• FastAPI：高性能的异步 Web 框架，用于构建 API。
• SQLAlchemy：具有异步支持的 SQL 工具包和 ORM。
• Pydantic v2：使用 Python 类型提示进行数据验证和设置管理。
• PostgreSQL：强大的开源关系数据库。
• Redis：内存数据存储，用于缓存和消息代理。
• Dramatiq：用于后台作业的分布式任务处理。
• APScheduler：先进的 Python 调度器，用于周期性任务。
• Alembic：数据库迁移工具。

准备工作和安装步骤

准备工作

在开始安装之前，请确保您的系统中已安装以下软件：

• Python 3.7 或更高版本
• Docker（推荐使用，但不是必须的）
• Git

安装步骤

1. 克隆项目仓库

   首先，您需要从 GitHub 克隆 fastapi-ignite 项目仓库到本地：

   git clone https://github.com/bakrianoo/fastapi-ignite.git
   cd fastapi-ignite
   

2. 配置环境变量

   复制 .env.example 文件并重命名为 .env，然后编辑该文件，根据您的配置设置环境变量：

   cp .env.example .env
   

   在 .env 文件中配置数据库连接字符串和其他所需的环境变量。

3. 安装依赖

   在项目目录中，创建一个虚拟环境并安装所需的依赖：

   python -m venv venv
   source venv/bin/activate  # 在 Windows 下使用 `venv\Scripts\activate`
   pip install -r requirements.txt
   pip install -r requirements-dev.txt
   

4. 设置数据库

   使用 Alembic 迁移工具设置数据库：

   alembic upgrade head
   

5. 启动 API 服务器

   运行以下命令以启动 API 服务器：

   python cli.py api --reload
   

6. 启动后台工作进程和调度器

   启动后台工作进程：

   python cli.py worker
   

   启动调度器：

   python cli.py scheduler
   

7. 访问 API 文档

   在浏览器中打开以下 URL，查看 Swagger UI 和 ReDoc 文档：

   • Swagger UI: http://localhost:8000/api/docs
   • ReDoc: http://localhost:8000/api/redoc

完成以上步骤后，您的 fastapi-ignite 应用程序应该已经成功安装并运行。您可以开始开发您的 Web 后端应用了。