Python 高性能 web 框架 - FastApi 全面指南

一、简介

FastAPI 是一个用于构建 API 的现代、快速（高性能）的 web 框架，使用 Python 3.6+ 并基于标准的 Python 类型提示。

它具有如下这些优点：

  • 快速：可与 NodeJS 和 Go 比肩的极高性能（归功于 Starlette 和 Pydantic）

  • 高效编码：提高功能开发速度约 200％ 至 300％

  • 更少 bug：减少约 40％ 的人为（开发者）导致错误。

  • 智能：极佳的编辑器支持。处处皆可自动补全，减少调试时间

  • 简单：设计的易于使用和学习，阅读文档的时间更短

  • 简短：使代码重复最小化。通过不同的参数声明实现丰富功能。bug 更少

  • 健壮：生产可用级别的代码。还有自动生成的交互式文档

  • 标准化：基于（并完全兼容）API 的相关开放标准：OpenAPI (以前被称为 Swagger) 和 JSON Schema。

二、安装

  1. pip install fastapi

ASGI 服务器可以使用uvicorn：

  1. pip install uvicorn[standard]

三、简单示例

创建一个 main.py 文件并写入以下内容:

  1. from typing import Optional
  3. from fastapi import FastAPI
  5. app = FastAPI()
  8. @app.get("/")
  9. def read_root():
  10.     return {"Hello": "World"}
  13. @app.get("/items/{item_id}")
  14. def read_item(item_id: int, q: Optional[str] = None):
  15.     return {"item_id": item_id, "q": q}

启动服务器：

  1. uvicorn main:app --reload

访问URL：http://127.0.0.1:8000/items/5?q=somequery，你将会看到如下 JSON 响应：

  1. {"item_id": 5, "q": "somequery"}

访问URL：http://127.0.0.1:8000/docs，你会看到自动生成的交互式 API 文档，由Swagger UI 生成：

Python 高性能 web 框架 - FastApi 全面指南 - 掘金 - 图1

访问URL：http://127.0.0.1:8000/redoc，你会看到另一个自动生成的文档（由ReDoc生成）：

Python 高性能 web 框架 - FastApi 全面指南 - 掘金 - 图2

四、请求

使用与 Python 格式化字符串相同的语法来声明路径”参数”或”变量”：

  1. from fastapi import FastAPI
  3. app = FastAPI()
  6. @app.get("/items/{item_id}")
  8. async def read_item(item_id):
  10.     return {"item_id": item_id}

路径参数item_id的值将作为参数item_id传递给你的函数。声明不属于路径参数的其他函数参数时，它们将被自动解释为”查询字符串”参数：

  1. from fastapi import FastAPI
  3. app = FastAPI()
  5. fake_items_db = [{"item_name": "Foo"}, {"item_name": "Bar"}, {"item_name": "Baz"}]
  8. @app.get("/items/")
  10. async def read_item(skip: int = 0, limit: int = 10):
  12.     return fake_items_db[skip : skip + limit]

查询字符串是键值对的集合，这些键值对位于 URL 的？之后，并以&符号分隔。

可以使用Query对查询进行额外的校验：

  1. from typing import Optional
  4. from fastapi import FastAPI, Query
  6. app = FastAPI()
  9. @app.get("/items/")
  10. async def read_items(q: Optional[str] = Query(None, max_length=50)):
  11.     results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
  12.     if q:
  13.         results.update({"q": q})
  14.     return results

Query 有如下这些字段校验：

  • min_length 最小长度
  • max_length 最大长度
  • regex 正则匹配
  • Query 第一个参数为默认值，...表示是必需的

Path和Query用法一样，也能对查询字段进行校验。

而且你还可以声明数值校验：

  1. from fastapi import FastAPI, Path, Query
  3. app = FastAPI()
  6. @app.get("/items/{item_id}")
  7. async def read_items(
  8.     *,
  9.     item_id: int = Path(..., title="The ID of the item to get", ge=0, le=1000),
  10.     q: str,
  12.     size: float = Query(..., gt=0, lt=10.5)
  14. ):
  15.     results = {"item_id": item_id}
  16.     if q:
  17.         results.update({"q": q})
  18.     return results

  • gt：大于

  • ge：大于等于

  • lt：小于

  • le：小于等于

类似的还有Cookie：

  1. from typing import Optional
  4. from fastapi import Cookie, FastAPI
  7. app = FastAPI()
  10. @app.get("/items/")
  11. async def read_items(ads_id: Optional[str] = Cookie(None)):
  12.     return {"ads_id": ads_id}

以及Header：

  1. from typing import Optional
  4. from fastapi import FastAPI, Header
  7. app = FastAPI()
  10. @app.get("/items/")
  11. async def read_items(user_agent: Optional[str] = Header(None)):
  12.     return {"User-Agent": user_agent}

还可以为路径设置tags标签进行分组：

  1. from typing import Optional, Set
  3. from fastapi import FastAPI
  4. from pydantic import BaseModel
  6. app = FastAPI()
  9. class Item(BaseModel):
  10.     name: str
  11.     description: Optional[str] = None
  12.     price: float
  13.     tax: Optional[float] = None
  14.     tags: Set[str] = []
  18. @app.post("/items/", response_model=Item, tags=["items"])
  20. async def create_item(item: Item):
  21.     return item
  25. @app.get("/items/", tags=["items"])
  27. async def read_items():
  28.     return [{"name": "Foo", "price": 42}]
  32. @app.get("/users/", tags=["users"])
  34. async def read_users():
  35.     return [{"username": "johndoe"}]

Python 高性能 web 框架 - FastApi 全面指南 - 掘金 - 图3

还可以设置summary 和 description:

  1. from typing import Optional, Set
  3. from fastapi import FastAPI
  4. from pydantic import BaseModel
  6. app = FastAPI()
  9. class Item(BaseModel):
  10.     name: str
  11.     description: Optional[str] = None
  12.     price: float
  13.     tax: Optional[float] = None
  14.     tags: Set[str] = []
  17. @app.post(
  18.     "/items/",
  19.     response_model=Item,
  21.     summary="Create an item",
  23.     description="Create an item with all the information, name, description, price, tax and a set of unique tags",
  25. )
  26. async def create_item(item: Item):
  27.     return item

多行注释：

  1. from typing import Optional, Set
  3. from fastapi import FastAPI
  4. from pydantic import BaseModel
  6. app = FastAPI()
  9. class Item(BaseModel):
  10.     name: str
  11.     description: Optional[str] = None
  12.     price: float
  13.     tax: Optional[float] = None
  14.     tags: Set[str] = []
  17. @app.post("/items/", response_model=Item, summary="Create an item")
  18. async def create_item(item: Item):
  20.     """
  22.     Create an item with all the information:
  26.     - **name**: each item must have a name
  28.     - **description**: a long description
  30.     - **price**: required
  32.     - **tax**: if the item doesn't have tax, you can omit this
  34.     - **tags**: a set of unique tag strings for this item
  36.     """
  38.     return item

Python 高性能 web 框架 - FastApi 全面指南 - 掘金 - 图4

废弃路由：

  1. from fastapi import FastAPI
  3. app = FastAPI()
  6. @app.get("/items/", tags=["items"])
  7. async def read_items():
  8.     return [{"name": "Foo", "price": 42}]
  11. @app.get("/users/", tags=["users"])
  12. async def read_users():
  13.     return [{"username": "johndoe"}]
  17. @app.get("/elements/", tags=["items"], deprecated=True)
  19. async def read_elements():
  20.     return [{"item_id": "Foo"}]

Python 高性能 web 框架 - FastApi 全面指南 - 掘金 - 图5

五、响应

使用response_model参数来声明用于响应的模型：

  1. from typing import List, Optional
  3. from fastapi import FastAPI
  4. from pydantic import BaseModel
  6. app = FastAPI()
  9. class Item(BaseModel):
  10.     name: str
  11.     description: Optional[str] = None
  12.     price: float
  13.     tax: Optional[float] = None
  14.     tags: List[str] = []
  18. @app.post("/items/", response_model=Item)
  20. async def create_item(item: Item):
  21.     return item
  • response_model_exclude_unset=True：响应中将不会包含那些默认值，而是仅有实际设置的值
  • response_model_include包含哪些属性
  • response_model_exclude省略某些属性

status_code参数来声明用于响应的 HTTP 状态码：

  1. from fastapi import FastAPI
  3. app = FastAPI()
  7. @app.post("/items/", status_code=201)
  9. async def create_item(name: str):
  10.     return {"name": name}

表单字段时，要使用Form：

  1. from fastapi import FastAPI, Form
  4. app = FastAPI()
  7. @app.post("/login/")
  8. async def login(username: str = Form(...), password: str = Form(...)):
  9.     return {"username": username}

File用于定义客户端的上传文件（接收上传文件，要预先安装[python-multipart](https%3A//andrew-d.github.io/python-multipart/)）：

  1. from fastapi import FastAPI, File, UploadFile
  4. app = FastAPI()
  7. @app.post("/files/")
  8. async def create_file(file: bytes = File(...)):
  9.     return {"file_size": len(file)}
  12. @app.post("/uploadfile/")
  13. async def create_upload_file(file: UploadFile = File(...)):
  14.     return {"filename": file.filename}

向客户端返回 HTTP 错误响应，可以使用HTTPException。

  1. from fastapi import FastAPI, HTTPException
  4. app = FastAPI()
  6. items = {"foo": "The Foo Wrestlers"}
  9. @app.get("/items/{item_id}")
  10. async def read_item(item_id: str):
  11.     if item_id not in items:
  12.         raise HTTPException(status_code=404, detail="Item not found")
  13.     return {"item": items[item_id]}

使用response_description设置响应描述：

  1. from typing import Optional, Set
  3. from fastapi import FastAPI
  4. from pydantic import BaseModel
  6. app = FastAPI()
  9. class Item(BaseModel):
  10.     name: str
  11.     description: Optional[str] = None
  12.     price: float
  13.     tax: Optional[float] = None
  14.     tags: Set[str] = []
  17. @app.post(
  18.     "/items/",
  19.     response_model=Item,
  20.     summary="Create an item",
  22.     response_description="The created item",
  24. )
  25. async def create_item(item: Item):
  26.     """
  27.     Create an item with all the information:
  29.     - **name**: each item must have a name
  30.     - **description**: a long description
  31.     - **price**: required
  32.     - **tax**: if the item doesn't have tax, you can omit this
  33.     - **tags**: a set of unique tag strings for this item
  34.     """
  35.     return item

Python 高性能 web 框架 - FastApi 全面指南 - 掘金 - 图6

六、JSON兼容

在某些情况下，你可能需要把数据（例如Pydantic模型）转换成JSON形式，例如存储在数据库中，这时候你就需要用到jsonable_encoder()方法。

  1. from datetime import datetime
  2. from typing import Optional
  4. from fastapi import FastAPI
  6. from fastapi.encoders import jsonable_encoder
  8. from pydantic import BaseModel
  10. fake_db = {}
  13. class Item(BaseModel):
  14.     title: str
  15.     timestamp: datetime
  16.     description: Optional[str] = None
  19. app = FastAPI()
  22. @app.put("/items/{id}")
  23. def update_item(id: str, item: Item):
  25.     json_compatible_item_data = jsonable_encoder(item)
  27.     fake_db[id] = json_compatible_item_data

七、依赖注入

FastAPI 提供了简单易用，但功能强大的依赖注入系统，可以让开发人员轻松地把组件集成至FastAPI。

什么是「依赖注入」？

依赖注入是一种消除类之间依赖关系的设计模式。把有依赖关系的类放到容器中，解析出这些类的实例，就是依赖注入。目的是实现类的解耦。

示例：

  1. from typing import Optional
  3. from fastapi import Depends, FastAPI
  5. app = FastAPI()
  9. async def common_parameters(q: Optional[str] = None, skip: int = 0, limit: int = 100):
  11.     return {"q": q, "skip": skip, "limit": limit}
  15. @app.get("/items/")
  16. async def read_items(commons: dict = Depends(common_parameters)):
  17.     return commons
  20. @app.get("/users/")
  21. async def read_users(commons: dict = Depends(common_parameters)):
  22.     return commons

本例中的依赖项预期接收如下参数：

  • 类型为 str 的可选查询参数 q
  • 类型为 int 的可选查询参数 skip，默认值是 0
  • 类型为 int 的可选查询参数 limit，默认值是 100

然后，依赖项函数返回包含这些值的 dict。

使用Class作为依赖：

  1. from typing import Optional
  3. from fastapi import Depends, FastAPI
  5. app = FastAPI()
  8. fake_items_db = [{"item_name": "Foo"}, {"item_name": "Bar"}, {"item_name": "Baz"}]
  11. class CommonQueryParams:
  12.     def __init__(self, q: Optional[str] = None, skip: int = 0, limit: int = 100):
  13.         self.q = q
  14.         self.skip = skip
  15.         self.limit = limit
  18. @app.get("/items/")
  20. async def read_items(commons: CommonQueryParams = Depends(CommonQueryParams)):
  22.     response = {}
  23.     if commons.q:
  24.         response.update({"q": commons.q})
  25.     items = fake_items_db[commons.skip : commons.skip + commons.limit]
  26.     response.update({"items": items})
  27.     return response

使用嵌套子依赖：

  1. from typing import Optional
  3. from fastapi import Cookie, Depends, FastAPI
  5. app = FastAPI()
  8. def query_extractor(q: Optional[str] = None):
  9.     return q
  12. def query_or_cookie_extractor(
  13.     q: str = Depends(query_extractor), last_query: Optional[str] = Cookie(None)
  14. ):
  15.     if not q:
  16.         return last_query
  17.     return q
  20. @app.get("/items/")
  22. async def read_query(query_or_default: str = Depends(query_or_cookie_extractor)):
  24.     return {"q_or_cookie": query_or_default}

在路径中使用依赖：

  1. from fastapi import Depends, FastAPI, Header, HTTPException
  3. app = FastAPI()
  6. async def verify_token(x_token: str = Header(...)):
  7.     if x_token != "fake-super-secret-token":
  8.         raise HTTPException(status_code=400, detail="X-Token header invalid")
  11. async def verify_key(x_key: str = Header(...)):
  12.     if x_key != "fake-super-secret-key":
  13.         raise HTTPException(status_code=400, detail="X-Key header invalid")
  14.     return x_key
  18. @app.get("/items/", dependencies=[Depends(verify_token), Depends(verify_key)])
  20. async def read_items():
  21.     return [{"item": "Foo"}, {"item": "Bar"}]

全局依赖项，可以为所有路径操作应用该依赖项：

  1. from fastapi import Depends, FastAPI, Header, HTTPException
  4. async def verify_token(x_token: str = Header(...)):
  5.     if x_token != "fake-super-secret-token":
  6.         raise HTTPException(status_code=400, detail="X-Token header invalid")
  9. async def verify_key(x_key: str = Header(...)):
  10.     if x_key != "fake-super-secret-key":
  11.         raise HTTPException(status_code=400, detail="X-Key header invalid")
  12.     return x_key
  16. app = FastAPI(dependencies=[Depends(verify_token), Depends(verify_key)])
  20. @app.get("/items/")
  21. async def read_items():
  22.     return [{"item": "Portal Gun"}, {"item": "Plumbus"}]
  25. @app.get("/users/")
  26. async def read_users():
  27.     return [{"username": "Rick"}, {"username": "Morty"}]

八、安全

在许多框架和系统中，仅处理安全性和身份认证就会花费大量的精力和代码（在许多情况下，可能占编写的所有代码的 50％ 或更多）。

FastAPI 提供了多种工具，可帮助你以标准的方式轻松、快速地处理安全性，而无需研究和学习所有的安全规范。

JWT 表示 「JSON Web Tokens」。

它是一个将 JSON 对象编码为密集且没有空格的长字符串的标准。字符串看起来像这样：

  1. eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

它没有被加密，因此任何人都可以从字符串内容中还原数据。

但它经过了签名。因此，当你收到一个由你发出的令牌时，可以校验令牌是否真的由你发出。

通过这种方式，你可以创建一个有效期为 1 周的令牌。然后当用户第二天使用令牌重新访问时，你知道该用户仍然处于登入状态。

一周后令牌将会过期，用户将不会通过认证，必须再次登录才能获得一个新令牌。而且如果用户（或第三方）试图修改令牌以篡改过期时间，你将因为签名不匹配而能够发觉。

OAuth2

OAuth2是一个规范，它定义了几种处理身份认证和授权的方法。

它是一个相当广泛的规范，涵盖了一些复杂的使用场景。

它包括了使用「第三方」进行身份认证的方法。

这就是所有带有「使用 Facebook，Google，Twitter，GitHub 登录」的系统背后所使用的机制。

下面演示了如何使用OAuth2 和 JWT进行用户验证。

  1. from datetime import datetime, timedelta
  2. from typing import Optional
  4. from fastapi import Depends, FastAPI, HTTPException, status
  5. from fastapi.security import OAuth2PasswordBearer, OAuth2PasswordRequestForm
  6. from jose import JWTError, jwt
  8. from passlib.context import CryptContext
  10. from pydantic import BaseModel
  12. # to get a string like this run:
  13. # openssl rand -hex 32
  14. SECRET_KEY = "09d25e094faa6ca2556c818166b7a9563b93f7099f6f0f4caa6cf63b88e8d3e7"
  15. ALGORITHM = "HS256"
  16. ACCESS_TOKEN_EXPIRE_MINUTES = 30
  19. fake_users_db = {
  20.     "johndoe": {
  21.         "username": "johndoe",
  22.         "full_name": "John Doe",
  23.         "email": "johndoe@example.com",
  24.         "hashed_password": "$2b$12$EixZaYVK1fsbw1ZfbX3OXePaWxn96p36WQoeG6Lruj3vjPGga31lW",
  25.         "disabled": False,
  26.     }
  27. }
  30. class Token(BaseModel):
  31.     access_token: str
  32.     token_type: str
  35. class TokenData(BaseModel):
  36.     username: Optional[str] = None
  39. class User(BaseModel):
  40.     username: str
  41.     email: Optional[str] = None
  42.     full_name: Optional[str] = None
  43.     disabled: Optional[bool] = None
  46. class UserInDB(User):
  47.     hashed_password: str
  51. pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto")
  54. oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")
  56. app = FastAPI()
  60. def verify_password(plain_password, hashed_password):
  62.     return pwd_context.verify(plain_password, hashed_password)
  67. def get_password_hash(password):
  68.     return pwd_context.hash(password)
  72. def get_user(db, username: str):
  73.     if username in db:
  74.         user_dict = db[username]
  75.         return UserInDB(**user_dict)
  79. def authenticate_user(fake_db, username: str, password: str):
  80.     user = get_user(fake_db, username)
  82.     if not user:
  84.         return False
  86.     if not verify_password(password, user.hashed_password):
  88.         return False
  90.     return user
  94. def create_access_token(data: dict, expires_delta: Optional[timedelta] = None):
  95.     to_encode = data.copy()
  96.     if expires_delta:
  97.         expire = datetime.utcnow() + expires_delta
  98.     else:
  99.         expire = datetime.utcnow() + timedelta(minutes=15)
  100.     to_encode.update({"exp": expire})
  101.     encoded_jwt = jwt.encode(to_encode, SECRET_KEY, algorithm=ALGORITHM)
  102.     return encoded_jwt
  105. async def get_current_user(token: str = Depends(oauth2_scheme)):
  106.     credentials_exception = HTTPException(
  107.         status_code=status.HTTP_401_UNAUTHORIZED,
  108.         detail="Could not validate credentials",
  109.         headers={"WWW-Authenticate": "Bearer"},
  110.     )
  111.     try:
  112.         payload = jwt.decode(token, SECRET_KEY, algorithms=[ALGORITHM])
  113.         username: str = payload.get("sub")
  114.         if username is None:
  115.             raise credentials_exception
  116.         token_data = TokenData(username=username)
  117.     except JWTError:
  118.         raise credentials_exception
  119.     user = get_user(fake_users_db, username=token_data.username)
  120.     if user is None:
  121.         raise credentials_exception
  122.     return user
  125. async def get_current_active_user(current_user: User = Depends(get_current_user)):
  126.     if current_user.disabled:
  127.         raise HTTPException(status_code=400, detail="Inactive user")
  128.     return current_user
  131. @app.post("/token", response_model=Token)
  132. async def login_for_access_token(form_data: OAuth2PasswordRequestForm = Depends()):
  133.     user = authenticate_user(fake_users_db, form_data.username, form_data.password)
  134.     if not user:
  135.         raise HTTPException(
  136.             status_code=status.HTTP_401_UNAUTHORIZED,
  137.             detail="Incorrect username or password",
  138.             headers={"WWW-Authenticate": "Bearer"},
  139.         )
  140.     access_token_expires = timedelta(minutes=ACCESS_TOKEN_EXPIRE_MINUTES)
  141.     access_token = create_access_token(
  142.         data={"sub": user.username}, expires_delta=access_token_expires
  143.     )
  144.     return {"access_token": access_token, "token_type": "bearer"}
  147. @app.get("/users/me/", response_model=User)
  148. async def read_users_me(current_user: User = Depends(get_current_active_user)):
  149.     return current_user
  152. @app.get("/users/me/items/")
  153. async def read_own_items(current_user: User = Depends(get_current_active_user)):
  154.     return [{"item_id": "Foo", "owner": current_user.username}]

  • OAuth2PasswordBearer：访问tokenUrl地址，获取token并返回

  • OAuth2PasswordRequestForm是一个类依赖项，声明了如下的请求表单：

    • username

    • password

    • 一个可选的 scope 字段，是一个由空格分隔的字符串组成的大字符串

    • 一个可选的 grant_type

    • 一个可选的 client_id

    • 一个可选的 client_secret

九、中间件

“中间件”是一个函数,它在每个请求被特定的路径操作处理之前,以及在每个响应返回之前工作。

要创建中间件你可以在函数的顶部使用装饰器 @app.middleware("http").

中间件参数接收如下参数:

  • request

  • 一个函数 call_next 它将接收 request 作为参数

    • 这个函数将 request 传递给相应的 路径操作
    • 然后它将返回由相应的路径操作生成的 response
  • 然后你可以在返回 response 前进一步修改它
  1. import time
  3. from fastapi import FastAPI, Request
  5. app = FastAPI()
  9. @app.middleware("http")
  11. async def add_process_time_header(request: Request, call_next):
  13.     start_time = time.time()
  15.     response = await call_next(request)
  17.     process_time = time.time() - start_time
  18.     response.headers["X-Process-Time"] = str(process_time)
  20.     return response

十、跨域设置

你可以在FastAPI应用中使用CORSMiddleware来配置跨域：

  1. from fastapi import FastAPI
  3. from fastapi.middleware.cors import CORSMiddleware
  6. app = FastAPI()
  9. origins = [
  10.     "http://localhost.tiangolo.com",
  11.     "https://localhost.tiangolo.com",
  12.     "http://localhost",
  13.     "http://localhost:8080",
  15. ]
  19. app.add_middleware(
  20.     CORSMiddleware,
  21.     allow_origins=origins,
  22.     allow_credentials=True,
  23.     allow_methods=["*"],
  24.     allow_headers=["*"],
  26. )
  30. @app.get("/")
  31. async def main():
  32.     return {"message": "Hello World"}

它支持以下参数：

  • allow_origins - 一个允许跨域请求的源列表。例如 ['https://example.org', 'https://www.example.org']。你可以使用 ['*'] 允许任何源。

  • allow_origin_regex - 一个正则表达式字符串，匹配的源允许跨域请求。例如 'https://.*\.example\.org'。

  • allow_methods - 一个允许跨域请求的 HTTP 方法列表。默认为 ['GET']。你可以使用 ['*'] 来允许所有标准方法。

  • allow_headers - 一个允许跨域请求的 HTTP 请求头列表。默认为 []。你可以使用 ['*'] 允许所有的请求头。Accept、Accept-Language、Content-Language 以及 Content-Type 请求头总是允许 CORS 请求。

  • allow_credentials - 指示跨域请求支持 cookies。默认是 False。另外，允许凭证时 allow_origins 不能设定为 ['*']，必须指定源。

  • expose_headers - 指示可以被浏览器访问的响应头。默认为 []。

  • max_age - 设定浏览器缓存 CORS 响应的最长时间，单位是秒。默认为 600。

十一、APIRouter

使用APIRouter同样也能对路由进行操作：

  1. from fastapi import APIRouter
  3. router = APIRouter()
  7. @router.get("/users/", tags=["users"])
  9. async def read_users():
  10.     return [{"username": "Rick"}, {"username": "Morty"}]
  14. @router.get("/users/me", tags=["users"])
  16. async def read_user_me():
  17.     return {"username": "fakecurrentuser"}
  21. @router.get("/users/{username}", tags=["users"])
  23. async def read_user(username: str):
  24.     return {"username": username}

为所有路径进行同样的操作：

  1. from fastapi import APIRouter, Depends, HTTPException
  3. from ..dependencies import get_token_header
  6. router = APIRouter(
  7.     prefix="/items",
  8.     tags=["items"],
  9.     dependencies=[Depends(get_token_header)],
  10.     responses={404: {"description": "Not found"}},
  11. )
  15. fake_items_db = {"plumbus": {"name": "Plumbus"}, "gun": {"name": "Portal Gun"}}
  19. @router.get("/")
  21. async def read_items():
  22.     return fake_items_db
  26. @router.get("/{item_id}")
  28. async def read_item(item_id: str):
  29.     if item_id not in fake_items_db:
  30.         raise HTTPException(status_code=404, detail="Item not found")
  31.     return {"name": fake_items_db[item_id]["name"], "item_id": item_id}
  34. @router.put(
  35.     "/{item_id}",
  36.     tags=["custom"],
  37.     responses={403: {"description": "Operation forbidden"}},
  38. )
  39. async def update_item(item_id: str):
  40.     if item_id != "plumbus":
  41.         raise HTTPException(
  42.             status_code=403, detail="You can only update the item: plumbus"
  43.         )
  44.     return {"item_id": item_id, "name": "The great Plumbus"}

该示例，就为所有的路径添加了前缀，标签、依赖和返回，而不用在每个路径上单独声明，简化了代码。

十二、Background Tasks

background tasks 就是在返回响应之后立即运行的任务。

  1. from fastapi import BackgroundTasks, FastAPI
  4. app = FastAPI()
  7. def write_notification(email: str, message=""):
  8.     with open("log.txt", mode="w") as email_file:
  9.         content = f"notification for {email}: {message}"
  10.         email_file.write(content)
  13. @app.post("/send-notification/{email}")
  14. async def send_notification(email: str, background_tasks: BackgroundTasks):
  15.     background_tasks.add_task(write_notification, email, message="some notification")
  16.     return {"message": "Notification sent in the background"}

十三、静态文件

首先需要安装aiofiles：

  1. pip install aiofiles

使用：

  1. from fastapi import FastAPI
  3. from fastapi.staticfiles import StaticFiles
  6. app = FastAPI()
  9. app.mount("/static", StaticFiles(directory="static"), name="static")

十四、子应用

如果你有2个独立的FastAPI的应用，你可以设置一个为主应用，另外一个为子应用：

  1. from fastapi import FastAPI
  4. app = FastAPI()
  9. @app.get("/app")
  11. def read_main():
  12.     return {"message": "Hello World from main app"}
  16. subapi = FastAPI()
  19. @subapi.get("/sub")
  20. def read_sub():
  21.     return {"message": "Hello World from sub API"}
  24. app.mount("/subapi", subapi)

十五、代理

可以使用root_path来设置代理。

使用命令行：

  1. uvicorn main:app --root-path /api/v1

或者在代码中设置：

  1. from fastapi import FastAPI, Request
  4. app = FastAPI(root_path="/api/v1")
  8. @app.get("/app")
  9. def read_main(request: Request):
  10.     return {"message": "Hello World", "root_path": request.scope.get("root_path")}

十六、使用模板

你可以在FastAPI中使用任何模板，常用的选择是Jinja2。

  1. pip install jinja2

使用：

  1. from fastapi import FastAPI, Request
  2. from fastapi.responses import HTMLResponse
  3. from fastapi.staticfiles import StaticFiles
  5. from fastapi.templating import Jinja2Templates
  8. app = FastAPI()
  10. app.mount("/static", StaticFiles(directory="static"), name="static")
  14. templates = Jinja2Templates(directory="templates")
  18. @app.get("/items/{id}", response_class=HTMLResponse)
  20. async def read_item(request: Request, id: str):
  21.     return templates.TemplateResponse("item.html", {"request": request, "id": id})

模板文件templates/item.html：

  1. <html>
  2. <head>
  3.     <title>Item Details</title>
  4.     <link href="{{ url_for('static', path='/styles.css') }}" rel="stylesheet">
  5. </head>
  6. <body>
  8.     <h1>Item ID: {{ id }}</h1>
  10. </body>
  11. </html>

十七：WebSockets

  1. from fastapi import FastAPI, WebSocket
  3. from fastapi.responses import HTMLResponse
  5. app = FastAPI()
  7. html = """
  8. <!DOCTYPE html>
  9. <html>
  10.     <head>
  11.         <title>Chat</title>
  12.     </head>
  13.     <body>
  14.         <h1>WebSocket Chat</h1>
  15.         <form action="" onsubmit="sendMessage(event)">
  16.             <input type="text" id="messageText" autocomplete="off"/>
  17.             <button>Send</button>
  18.         </form>
  19.         <ul id='messages'>
  20.         </ul>
  21.         <script>
  22.             var ws = new WebSocket("ws://localhost:8000/ws");
  23.             ws.onmessage = function(event) {
  24.                 var messages = document.getElementById('messages')
  25.                 var message = document.createElement('li')
  26.                 var content = document.createTextNode(event.data)
  27.                 message.appendChild(content)
  28.                 messages.appendChild(message)
  29.             };
  30.             function sendMessage(event) {
  31.                 var input = document.getElementById("messageText")
  32.                 ws.send(input.value)
  33.                 input.value = ''
  34.                 event.preventDefault()
  35.             }
  36.         </script>
  37.     </body>
  38. </html>
  39. """
  42. @app.get("/")
  43. async def get():
  44.     return HTMLResponse(html)
  48. @app.websocket("/ws")
  50. async def websocket_endpoint(websocket: WebSocket):
  51.     await websocket.accept()
  52.     while True:
  53.         data = await websocket.receive_text()
  54.         await websocket.send_text(f"Message text was: {data}")

十八、startup - shutdown事件

你可以设置应用的启动和关闭事件回调函数：

  1. from fastapi import FastAPI
  3. app = FastAPI()
  5. items = {}
  7. @app.on_event("shutdown")
  8. def shutdown_event():
  9.     with open("log.txt", mode="a") as log:
  10.         log.write("Application shutdown")
  13. @app.on_event("startup")
  14. async def startup_event():
  15.     items["foo"] = {"name": "Fighters"}
  16.     items["bar"] = {"name": "Tenders"}
  19. @app.get("/items/{item_id}")
  20. async def read_items(item_id: str):
  21.     return items[item_id]