FastAPI 如何在Python Fast API中通过Swagger文档传递授权头

在本文中，我们将介绍如何在Python FastAPI中通过Swagger文档传递授权头。FastAPI是一个高性能的Web框架，基于Python类型提示实现，它能够自动生成交互式的Swagger文档。

什么是授权头？

授权头是通过HTTP请求头部传递的一种验证机制，用于验证请求的合法性。在API开发中，常用的授权头如Bearer Token，用于验证用户的身份。

FastAPI中的Swagger文档

Swagger是一个API规范和交互式文档的集成解决方案。FastAPI集成了Swagger，使开发者可以方便地查看和测试API端点。

在FastAPI中，我们可以通过在API路由函数的参数中声明Request对象，来获取请求的信息，包括授权头。

下面是一个示例，展示了如何在FastAPI中通过Swagger文档传递授权头：

from fastapi import Depends, FastAPI, HTTPException, Request
from fastapi.security import OAuth2PasswordBearer

app = FastAPI()

oauth2_scheme = OAuth2PasswordBearer(tokenUrl="/token")

@app.get("/items/")
async def read_items(request: Request, token: str = Depends(oauth2_scheme)):
    if not token:
        raise HTTPException(status_code=401, detail="Invalid token")
    return {"token": token}

在上面的代码中，我们使用Depends注解和OAuth2PasswordBearer来声明token参数。token参数将包含传递的授权头信息。

在Swagger文档中传递授权头

为了在Swagger文档中传递授权头，我们需要在API端点函数上添加额外的元数据。FastAPI提供了security参数，用于指定需要的授权方式。

下面是一个示例，展示了如何在Swagger文档中传递授权头：

@app.get("/items/", security=[{"BearerAuth": []}])
async def read_items(request: Request, token: str = Depends(oauth2_scheme)):
    if not token:
        raise HTTPException(status_code=401, detail="Invalid token")
    return {"token": token}