FastAPI-Ignite 项目启动与配置教程

1. 项目目录结构及介绍

FastAPI-Ignite 是一个功能完备的生产级 FastAPI 项目模板。以下是项目的目录结构及其简要介绍：

• alembic: 包含数据库迁移脚本。
• docs: 存放项目文档。
• src: 项目的核心源代码，包括路由、模型、服务等。
  • cli.py: 命令行接口，用于运行不同的命令，如启动 API、数据库迁移等。
  • main.py: FastAPI 应用入口点。
• tests: 测试代码。
• .env.example: 配置文件示例，用于设置环境变量。
• .gitignore: 指定 Git 忽略的文件和目录。
• Dockerfile: 用于创建 Docker 容器的文件。
• LICENSE: 项目许可证信息。
• README.md: 项目说明文件。
• requirements.txt: 项目依赖的 Python 包列表。
• requirements-dev.txt: 开发环境依赖的 Python 包列表。

2. 项目的启动文件介绍

项目的主要启动文件是 src/main.py。以下是该文件的基本内容：

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def root():
    return {"message": "Hello World"}

这个简单的 FastAPI 应用定义了一个根路由 /，当访问该路由时，会返回 "Hello World"。

要启动 FastAPI 应用，你可以使用以下命令：

python src/cli.py api --reload

该命令会通过 cli.py 文件中的 api 命令来启动应用，并且 --reload 参数会使得应用在代码更改时自动重启。

3. 项目的配置文件介绍

项目的配置是通过环境变量来管理的，配置文件示例为 .env.example。你需要将这个文件的副本 .env.example 重命名为 .env 并根据自己的需求编辑它。

以下是 .env 文件中可能包含的一些配置项：

DATABASE_URL=postgresql://username:password@localhost/dbname
SECRET_KEY=your_secret_key
JWT_TOKEN_EXPIRE_MINUTES=60

这些环境变量用于配置数据库连接、JWT 密钥和 Token 过期时间等。

确保在本地开发环境和生产环境中正确设置这些环境变量，以保证应用能够正确地访问数据库和其他服务。

在开发环境中，你可以使用 python -m venv venv 来创建一个虚拟环境，然后激活它，并使用 pip install -r requirements.txt 和 pip install -r requirements-dev.txt 来安装依赖项。

在配置好环境变量并安装完依赖后，你可以通过以下命令来运行数据库迁移：

python src/cli.py db migrate

然后，启动 API 服务器：

python src/cli.py api --reload

以上就是 FastAPI-Ignite 项目的启动和配置的基本教程。