使用 FastAPI 解析来自 Slack 的传入 POST 请求

我正在构建一个 FastAPI 服务器来接收 slacklash 命令发送的请求。使用下面的代码，我可以看到以下内容：

token=BLAHBLAH&team_id=BLAHBLAH&team_domain=myteam&channel_id=BLAHBLAH&channel_name=testme&user_id=BLAH&user_name=myname&command=%2Fwhatever&text=test&api_app_id=BLAHBLAH&is_enterprise_install=false&response_url=https%3A%2F%2Fhooks.slack.com%2Fcommands%BLAHBLAH&trigger_id=BLAHBLAHBLAH

被打印出来，这正是我在官方文档。我正在尝试使用有效负载信息来做某事，我很好奇是否有一种解析此有效负载信息的好方法。我绝对可以使用 split 函数或任何其他漂亮的函数来解析这个有效负载，但我很好奇是否有一种“事实上的”方法来处理松弛有效负载。提前致谢！

from fastapi import FastAPI, Request

app = FastAPI()

@app.post("/")
async def root(request: Request):
    request_body = await request.body()
    print(request_body)

Receive JSON data

你通常会使用用于声明请求主体的 Pydantic 模型- 如果您要接收数据JSON形式 - 因此受益于验证Pydantic必须提供（有关如何发布的更多选项JSON数据，看一下这个答案）。因此，您可以定义这样的模型：

from pydantic import BaseModel

class Item(BaseModel):
    token: str
    team_id: str
    team_domain: str
    # etc.

@app.post("/")
def root(item: Item):
    print(item.dict())  # convert to dictionary (if required)
    return item

有效负载如下所示：

{
    "token": "gIkuvaNzQIHg97ATvDxqgjtO"
    "team_id": "Foo",
    "team_domain": "bar",
    # etc.
}

Receive Form data

但是，如果您即将收到有效负载Form data，就像 slack API 所做的那样（如link你提供的），你可以使用Form字段。和Form字段，您的有效负载仍将根据这些字段以及您定义它们的类型进行验证。但是，您需要定义端点中的所有参数，如上面的链接所述，如下所示：

from fastapi import  Form

@app.post("/")
def root(token: str = Form(...), team_id: str = Form(...), team_domain: str = Form(...)):
    return {"token": token, "team_id": team_id, "team_domain": team_domain}

或者避免在端点中指定参数，以防您有大量Form字段，您可以创建一个自定义依赖类（使用@dataclass装饰器，为了简单起见），这将允许您定义多个Form单独类中的字段，并且仅在端点中使用该类定义 - 请参阅这个答案 and 这个答案有关 FastAPI 依赖项的更多详细信息。例子：

from dataclasses import dataclass
from fastapi import FastAPI, Form, Depends

@dataclass
class Item:
    token: str = Form(...)
    team_id: str = Form(...)
    team_domain: str = Form(...)
    #...

@app.post("/")
def root(data: Item = Depends()):
    return data

由于 FastAPI 实际上是 Starlette，即使您仍然必须按照问题中的方式访问请求正文，您也应该使用以下方法request.json() or request.form()，如中所述星光文档，这将允许您将请求正文解析为JSON or form-data， 分别。请看一下这个答案了解更多详细信息和示例。