FastAPI和APIRouter

在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进行分组和分类。
  • 使用场景:当希望按照功能模块来划分路由时,比如用户管理模块、文章管理模块等,每个模块可以有一个独立的路由器,然后将这些路由器添加到主应用中。

示例流程

  1. 创建FastAPI应用

    python 复制代码
    from fastapi import FastAPI
    app = FastAPI()
  2. 创建路由器

    python 复制代码
    from fastapi import APIRouter
    router = APIRouter()
  3. 定义路由到路由器

    python 复制代码
    @router.get("/items/{item_id}")
    async def read_item(item_id: int):
        return {"item_id": item_id}
  4. 将路由器挂载到FastAPI应用

    python 复制代码
    app.include_router(router)

通过这样的架构,你可以轻松地管理和扩展API,特别是在团队协作或大型项目中,每个团队或模块可以专注自己的路由器,而整体应用的结构依旧保持清晰和有序。

相关推荐
杰瑞学AI14 小时前
我的全栈学习之旅:FastAPI (持续更新!!!)
后端·python·websocket·学习·http·restful·fastapi
Python私教4 天前
浏览器不再拦请求:FastAPI 跨域(CORS)配置全解析
fastapi
带娃的IT创业者6 天前
第2集:技术选型的智慧:Flask vs FastAPI,GLM-4 vs GPT
python·gpt·flask·fastapi·glm·技术选型
万粉变现经纪人9 天前
如何解决 pip install 安装报错 ImportError: cannot import name ‘xxx’ from ‘yyy’ 问题
python·selenium·测试工具·flask·scikit-learn·fastapi·pip
闲人编程11 天前
2025年,如何选择Python Web框架:Django, Flask还是FastAPI?
前端·后端·python·django·flask·fastapi·web
chao_78911 天前
Union 和 Optional 区别
开发语言·数据结构·python·fastapi
BTU_YC11 天前
Django+FastAPI+Vue微服务架构指南
架构·django·fastapi
Gerlat小智12 天前
【Python精讲 16】实战项目演练(二):用Flask/FastAPI发布你的第一个Web API
python·flask·fastapi
onelafite13 天前
淘宝开放平台拍立淘接口返回参数及调用操作指南
api·fastapi
weixin_4211334113 天前
使用 SQLAlchemy 和 Alembic 处理 FastAPI 中的模型变更
fastapi