在FastAPI框架中,app = FastAPI()
和 router = APIRouter()
分别代表了应用的两个核心构建块,它们在构建API时扮演着不同的角色:
1、app = FastAPI()
这行代码是创建FastAPI应用实例的起点。FastAPI
类是FastAPI框架的核心,它继承自Starlette,提供了一个高性能的Web应用基础结构,专为构建API设计。当你初始化一个 FastAPI
实例(通常命名为 app
),你就创建了一个可以接收HTTP请求、处理请求、返回响应的应用服务器。
- 作用:定义整个Web应用的基本配置,如中间件、全局异常处理、依赖注入等。
- 功能 :可以挂载路由、配置中间件、设置全局参数等,是应用的入口点。
- 使用场景 :几乎在每个FastAPI项目中都会首先创建这样一个实例,并通过它来组织和配置整个应用。
2、router = APIRouter()
而 APIRouter
是FastAPI中用于组织和分组路由的一个类。通过创建一个 APIRouter
实例(通常命名为 router
),可以将相关的路由(如属于同一功能模块的路由)聚合在一起,然后将这个路由器挂载到主应用 app
中,以此来保持代码的组织性和可维护性。
- 作用:帮助组织和模块化路由,使得大型应用的路由管理更加清晰。
- 功能:可以有自己的中间件、全局依赖项、前缀、标签等,便于对API进行分组和分类。
- 使用场景:当希望按照功能模块来划分路由时,比如用户管理模块、文章管理模块等,每个模块可以有一个独立的路由器,然后将这些路由器添加到主应用中。
示例流程
-
创建FastAPI应用:
pythonfrom fastapi import FastAPI app = FastAPI()
-
创建路由器:
pythonfrom fastapi import APIRouter router = APIRouter()
-
定义路由到路由器:
python@router.get("/items/{item_id}") async def read_item(item_id: int): return {"item_id": item_id}
-
将路由器挂载到FastAPI应用:
pythonapp.include_router(router)
通过这样的架构,你可以轻松地管理和扩展API,特别是在团队协作或大型项目中,每个团队或模块可以专注自己的路由器,而整体应用的结构依旧保持清晰和有序。