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,特别是在团队协作或大型项目中,每个团队或模块可以专注自己的路由器,而整体应用的结构依旧保持清晰和有序。

相关推荐
外收内放9 小时前
FastAPI猜字谜实战(4):让AI主持人开口
开发语言·python·学习·fastapi
外收内放11 小时前
FastAPI猜字谜实战(6):日志与异常
开发语言·python·学习·fastapi
小林ixn12 小时前
用 FastAPI + SQLAlchemy 从零手搓一个博客系统:一套能落地、能讲清楚的 RESTful 后端
后端·python·fastapi
外收内放13 小时前
FastAPI猜字谜实战(5):会话管理
开发语言·python·学习·fastapi
Sakura_j_h_1 天前
给 FastAPI 接大模型:超时、重试和 token 成本该怎么管
python·大模型·fastapi·超时重试·token计费
小林ixn2 天前
FastAPI + LangChain 实战:从 0 到 1 打造高性能 AI 后端服务
人工智能·langchain·fastapi
ratel️2 天前
小墨析 · Office Agent 日常办公不烧心
python·langchain·word·excel·fastapi·js·ppt
外收内放3 天前
FastAPI猜字谜实战(3):把每一局存成JSON
开发语言·python·学习·json·fastapi
Json____3 天前
用 FastAPI + Vue3 打造一套健身私教课预约管理系统
后端·fastapi·it学习·wwwoop.com
溪语流沙3 天前
【Web全栈进阶】监控与告警:线上系统的“体检报告”
前端·vue.js·python·fastapi