在 FastAPI 中使用 uv

FastAPI 是一个现代的高性能 Python Web 框架。你可以使用 uv 来管理 FastAPI 项目，包括安装依赖、管理环境、运行 FastAPI 应用程序等。

Note

你可以在 uv-fastapi-example 仓库中查看本指南的源代码。

迁移现有的 FastAPI 项目

作为示例，考虑 FastAPI 文档中定义的示例应用程序，其结构如下：

project
└── app
    ├── __init__.py
    ├── main.py
    ├── dependencies.py
    ├── routers
    │   ├── __init__.py
    │   ├── items.py
    │   └── users.py
    └── internal
        ├── __init__.py
        └── admin.py

要在这个应用程序中使用 uv，在 project 目录下运行：

$ uv init --app

这将创建一个带有应用程序布局的项目和一个 pyproject.toml 文件。

接下来，添加 FastAPI 依赖：

$ uv add fastapi --extra standard

此时，你应该得到如下的项目结构：

project
├── pyproject.toml
└── app
    ├── __init__.py
    ├── main.py
    ├── dependencies.py
    ├── routers
    │   ├── __init__.py
    │   ├── items.py
    │   └── users.py
    └── internal
        ├── __init__.py
        └── admin.py

pyproject.toml 文件的内容应该类似于以下内容：

pyproject.toml

[project]
name = "uv-fastapi-example"
version = "0.1.0"
description = "FastAPI project"
readme = "README.md"
requires-python = ">=3.12"
dependencies = [
    "fastapi[standard]",
]

从此，你可以通过以下命令运行 FastAPI 应用程序：

$ uv run fastapi dev

uv run 将自动解析并锁定项目依赖（即创建一个 uv.lock 文件和 pyproject.toml 文件），创建一个虚拟环境，并在该环境中运行命令。

在 Web 浏览器中打开 http://127.0.0.1:8000/?token=jessica 来测试应用程序。

部署

要使用 Docker 部署 FastAPI 应用程序，你可以使用以下 Dockerfile：

Dockerfile

FROM python:3.12-slim

# 安装 uv
COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/

# 将应用程序复制到容器中
COPY . /app

# 安装应用程序依赖
WORKDIR /app
RUN uv sync --frozen --no-cache

# 运行应用程序
CMD ["/app/.venv/bin/fastapi", "run", "app/main.py", "--port", "80", "--host", "0.0.0.0"]

使用以下命令构建 Docker 镜像：

$ docker build -t fastapi-app .

使用以下命令在本地运行 Docker 容器：

$ docker run -p 8000:80 fastapi-app

在浏览器中访问 http://127.0.0.1:8000/?token=jessica 来验证应用程序是否正确运行。

Tip

关于如何在 Docker 中使用 uv，参见 Docker 指南。