Skip to content
On this page

建立外部路由

建立外部路由使用APIRouter模組,將設定的路由包起來。

py
# route.py
from fastapi import APIRouter,Depends
from .dependencies import get_token_header

app=FastAPI()
# 建立新router,指定路由根目錄為"/items"
router=APIRouter(
    prefix="/items",
    tags=["items"],
    dependencies=[Depends(get_token_header)],
    responses={404: {"description": "Not found"}},
)
# 雖然為 "/"跟目錄,實際顯示會變成 "/items"
@router.get('/')
def get_data():
    return pass

TIP

指定路由會有4個選項:

  • prefix : 指定路由
  • tags : 路由標籤
  • dependencies : 依賴項目(例如指定token,需相符才能進入路由內)
  • responses : 回饋路由(如果依賴項目錯誤,則導向其他方向,例如404)

上述也可寫在主檔maininclude_router


引入外部路由

在主檔中將外部router包起來。

py
# main.py
from routers import router
# 把指定的路由涵蓋起來
app.include_router(router)

參考