本次的程式碼與目錄結構可以參考 FastAPI Tutorial : Day09 branch
- FastAPI 的架構
- 如何使用 Typing 和 Pydantic 定義 Schema
response_model的用法- 如何在 Swagger 中加入更多資訊
那今天我們今天來優化目前專案的架構
因為目前所有 router 都放在 main.py 中，會讓程式碼變得難以維護
一般在 FastAPI 專案中
我們會將所有 API 的 router 都放在特定資料夾中
常見的命名有: routers 、 api 或 endpoints
在這邊我們使用 api 這個名稱
首先我們先在專案中新增一個 apis 資料夾
並在 api 中新增一個 __init__.py
mkdir api
touch api/__init__.py
touch api/{users,items}.py接著我們將 main.py 中 users 相關的 router 移動到 api 中
所以會使用到 FastAPI 中的 APIRouter
api/users.py
from fastapi import APIRouter
router = APIRouter()
@router.get("/users")
async def read_users():
return [{"username": "Foo"}, {"username": "Bar"}]而 APIRouter 的用法和原本 main.py 中的 app instance 一樣
都是透過 decorator 來定義
所以只要將 main.py 中的 app 改成 router 即可
更新完整的 api/users.py 如下
from fastapi import APIRouter, HTTPException, status
from typing import List , Dict
from schemas import users as UserSchema
from database.fake_db import get_db
fake_db = get_db()
router = APIRouter()
@router.get("/users",
response_model=List[UserSchema.UserRead],
response_description="Get list of user",
)
def get_users(qry: str = None):
"""
Create an user list with all the information:
- **id**
- **name**
- **email**
- **avatar**
"""
return fake_db['users']
# ....
# 剩下的可以到 Day08 的 repo 中看程式碼接著我們要將 api/users.py 中的 router 加入到 main.py 中
所以我們要使用到 FastAPI 中的 include_router
main.py
from fastapi import FastAPI
from api.users import router as users_router
app = FastAPI()
app.include_router(users_router)就可以將 api/users.py 中的 router 加入到 main.py 中
接著把剩下與 items 相關的 router 也分切加入到 api/items.py 中
而最後 / 與 /infor 放到 api/infor.py 中
調整完成後的專案架構如下
.
├── api
│ ├── infor.py
│ ├── items.py
│ └── users.py
├── database
│ └── fake_db.py
├── main.py
├── run.py
├── schemas
│ ├── items.py
│ └── users.py
└── setting
├── .env.dev
├── .env.prod
├── .env.test
└── config.py
4 directories, 12 files
到 Swagger 中可以看到
所有的 API 都與之前相同
但我們還可以為 API 加上 tags
tags 的用途是可以讓我們在 Swagger 中將 API 分類
api/users.py
# ...
from fastapi import APIRouter
router = APIRouter(
tags=["users"] # <-- tags
)
@router.get("/users")
# ...api/items.py 與 api/infor.py 也加上 tags 後
再次到 Swagger 中看看
在 Swagger 中每個類別的 API 都依照 tags 分在不同區塊
這樣就可以讓我們的 Swagger 更結構化
接著我們可以為每個 router 加上 prefix
prefix 的用途是可以讓我們在 APIRouter 中加上前綴
一般來說在後端 API 會加上 /api 作為前綴
api/users.py
# ...
router = APIRouter(
tags=["users"],
prefix="/api" # <-- prefix
)
# ...api/items.py 也加上 prefix 後
再次到 Swagger 中看看
可以看到 Swagger 中的 users 與 items 的 API 都被加上 /api 作為前綴
今天我們學到:
- 依據項目切分 router
- 將個別 router 加入到
main.py中 - 使用
tags來調整 Swagger 的顯示 - 使用
prefix來為 API 加上前綴