标签：return 33 FastAPI app Global Depends token key

背景

对于某些实际应用场景，希望向整个应用程序添加一个全局依赖项

FastAPI 类的 dependences 参数

• dependences 类型指定为  Optional[Sequence[Depends]] 
• Sequence 是序列，不仅可以接收 List，还可以接收 Set、Tuple 等
• 子类型就是 Depends

实际代码

#!usr/bin/env python
# -*- coding:utf-8 _*-
"""
# author: 小菠萝测试笔记
# blog:  https://www.cnblogs.com/poloyy/
# time: 2021/9/25 12:52 下午
# file: 28_path_depends.py
"""
from typing import Optional

import uvicorn
from fastapi import Depends, FastAPI, HTTPException, Header, APIRouter


# 1、第一个依赖，验证请求头中的 x_token
async def verify_token(x_token: str = Header(...)):
    if x_token != "fake-super-secret-token":
        # 验证失败，则抛出异常
        raise HTTPException(status_code=400, detail="X-Token header invalid")
    # 没有 return


# 2、第二个依赖，验证请求头中的 x_key
async def verify_key(x_key: str = Header(...)):
    if x_key != "fake-super-secret-key":
        # 验证失败，则抛出异常
        raise HTTPException(status_code=400, detail="X-Key header invalid")
    # 有 return
    return x_key

# 添加全局依赖
app = FastAPI(dependencies=[Depends(verify_token), Depends(verify_key)])


@app.get("/items/")
async def read_items():
    return [{"item": "Portal Gun"}, {"item": "Plumbus"}]


@app.get("/users/")
async def read_users():
    return [{"username": "Rick"}, {"username": "Morty"}]


if __name__ == "__main__":
    uvicorn.run(app="29_global_depends:app", host="127.0.0.1", port=8080, reload=True, debug=True)

• 在实例化 FastAPI 的时候传 dependences 参数，就可以声明全局依赖项啦
• 发起的所有请求都会先执行全局依赖项，然后再执行对应的路径操作函数

查看 Swagger API 文档

正确请求 /items 的结果

验证失败 /users 的结果

标签：return,33,FastAPI,app,Global,Depends,token,key
来源： https://www.cnblogs.com/poloyy/p/15334280.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。