python - 如何限制 FastAPI 请求 header 中的内容类型

Question

我是 FastAPI 框架的新手，我想用“application/vnd.api+json”来限制我的请求 header 内容类型，但我无法找到一种方法来配置我的内容类型快速 API 路由实例。

任何信息都会非常有用。

Answer 1

更好的方法是声明依赖:

from fastapi import FastAPI, HTTPException, status, Header, Depends


app = FastAPI()


def application_vnd(content_type: str = Header(...)):
    """Require request MIME-type to be application/vnd.api+json"""

    if content_type != "application/vnd.api+json":
        raise HTTPException(
            status.HTTP_415_UNSUPPORTED_MEDIA_TYPE,
            f"Unsupported media type: {content_type}."
            " It must be application/vnd.api+json",
        )


@app.post("/some-path", dependencies=[Depends(application_vnd)])
def some_path(q: str = None):
    return {"result": "All is OK!", "q": q}

所以它可以在需要时重复使用。

对于成功的请求，它将返回如下内容:

{
    "result": "All is OK!",
    "q": "Some query"
}

对于像这样不成功的事情:

{
    "detail": "Unsupported media type: type/unknown-type. It must be application/vnd.api+json"
}