FastApi-21-APIRouter

最新推荐文章于 2025-06-16 22:34:02 发布

原创最新推荐文章于 2025-06-16 22:34:02 发布 · 1.3k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#路由器 #web #vnc #epoll #rpc

本文介绍了FastAPI中的APIRouter使用方法。通过项目结构展示，解释了如何在视图和主入口文件中定义及注册路由器。示例代码演示了如何创建和使用APIRouter，包括定义GET请求的用户和图片列表接口。最后，通过浏览器访问展示了路由的实际效果。快速理解并应用APIRouter，提升FastAPI开发效率。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Part1背景

通常在我们开发 app 时都会用到路由，像 Flask 有 blueprint，Django 有 urls 等，其目的都是为了路由汇总管理。FastApi 也不例外，其拥有 APIRouter。今天我们就一起来了解 APIRouter 是如何使用的。

Part2项目结构

项目目录

以上，model 为模型层，templates 为 html 模板，views 为视图（其中每个视图都有其独立的路由器），main 为 app 入口，所有的 APIRouter 都在这里注册。

Part3代码

1视图中路由器的定义和使用

from fastapi import FastAPI,Depends,Header,HTTPException,APIRouter
from starlette.requests import Request
from starlette.templating import Jinja2Templates
from starlette import status
import uvicorn
from deta import Deta
from fastapi.responses import StreamingResponse

# 实例化路由器
router = APIRouter()
templates = Jinja2Templates('templates')

# 注意，视图这里使用router来声明请求方式&URI
@router.get('/users/')
def user_list():

    return "这是用户们"

@router.get('/imgs/')
def img_list():
    return "这是图片"

2main 中的路由器注册

from fastapi import Depends, FastAPI
from views import user
from views.utm import login_required
import uvicorn

# 如果需要开启app鉴权，则用这种方式↓
# app = FastAPI(dependencies=[Depends(login_required)])

app = FastAPI() # 免鉴权

app.include_router(
    user.router,
    prefix='/um',
    tags=['um'],
    responses={520: {"description": "I'm a user description!"}}
    )

@app.get("/")
async def root():
    return {"message": "Welcome to Applications APIRouter!"}

if __name__ == "__main__":
    uvicorn.run(app='main:app',host='127.0.0.1',port=8765,reload=True)