FastAPI 如何组织大型应用？

推荐答案

在 FastAPI 中组织大型应用时，推荐使用模块化的结构来管理代码。以下是一个常见的组织方式：

1. 按功能模块划分：将应用按功能模块划分，每个模块包含自己的路由、模型、服务和依赖项。
2. 使用 APIRouter：每个模块使用 APIRouter 来定义自己的路由，最后将这些路由集中到主应用中。
3. 依赖注入：通过依赖注入来管理共享的逻辑，如数据库连接、认证等。
4. 配置文件：使用配置文件来管理环境变量和配置项。
5. 测试和文档：为每个模块编写单元测试，并利用 FastAPI 的自动文档生成功能。

本题详细解读

1. 按功能模块划分

在大型应用中，通常会有多个功能模块，例如用户管理、订单管理、产品管理等。每个模块可以作为一个独立的包或目录，包含以下内容：

• routes.py：定义该模块的路由。
• models.py：定义该模块的数据模型。
• services.py：包含业务逻辑。
• dependencies.py：定义该模块的依赖项。

2. 使用 APIRouter

APIRouter 是 FastAPI 提供的一个工具，用于将路由分组。每个模块可以创建一个 APIRouter 实例，并在其中定义自己的路由。例如：

from fastapi import APIRouter

router = APIRouter(prefix="/users", tags=["users"])

@router.get("/")
async def get_users():
    return {"message": "Get all users"}

然后在主应用中将这些路由集中起来：

from fastapi import FastAPI
from .users.routes import router as user_router

app = FastAPI()

app.include_router(user_router)

3. 依赖注入

依赖注入是 FastAPI 的一个强大特性，可以用来管理共享的逻辑。例如，数据库连接可以作为一个依赖项：

-- -------------------- ---- -------
---- ------- ------ -------
---- -------------- ------ -------

--- ---------
    -- - --------------
    ----
        ----- --
    --------
        ----------

-------------------------
----- --- ----------------- ---- --- ------- - -----------------
    ---- - ----------------------------- -- ----------------
    ------ ----

4. 配置文件

使用配置文件来管理环境变量和配置项是一个好习惯。可以使用 pydantic 的 BaseSettings 来定义配置类：

-- -------------------- ---- -------
---- -------- ------ ------------

----- -----------------------
    ------------- ---

    ----- -------
        -------- - ------

-------- - ----------

5. 测试和文档

为每个模块编写单元测试，确保代码的可靠性。FastAPI 提供了自动生成文档的功能，可以通过访问 /docs 或 /redoc 来查看 API 文档。

from fastapi.testclient import TestClient

client = TestClient(app)

def test_get_users():
    response = client.get("/users/")
    assert response.status_code == 200
    assert response.json() == {"message": "Get all users"}

通过以上方式，可以有效地组织和管理大型 FastAPI 应用。