何时/何地在FastAPI中使用Body/Path/Query/Field？

Question

我正在学习FastAPI的教程，到目前为止，我对何时/何地在FastAPI中使用Body/Path/Query/Field有疑问？因为它们似乎都以相同的方式工作，所以本教程对它们的区别使用了模糊的解释，还是我遗漏了什么？

额外问题：*真的有用吗？我在教程的示例代码中设置/省略了它，但我看不出有什么区别。

Answer 1

事实上，他们完全不同。

让我们以FastAPI链接标记的问题的URL为例，并将其分成几个部分。

https://stackoverflow.com/questions/tagged/fastapi?sort=Newest&uqlId=26120

• 堆栈溢出。com-

如果你想在FastAPI中创建它，它看起来会像这样。

from enum import Enum


class SortTypes(str, Enum):
    newest: str = "Newest"
    unanswered: str = "Unanswered"
    active: str = "Active"
    bountied: str = "Bountied"


@app.get("/questions/tagged/{tag}")
async def get_questions_with_tags(tag: str, sort: SortTypes, uqlId: int):
    return ...

查询参数和路径参数的工作原理几乎相同。

但身体完全不同。

您无法从URL看到请求的主体，您的客户端以字节的形式发送HTTP主体，但它可以包含任何内容，您需要通过HTTP头指定主体包含的内容。

这样做，就是告诉服务器应该如何处理该主体。例如

假设您正在发送一个JSON{“name”：“foo”}，它将与这个头一起发送{“Content Type”：“application/JSON”}，您的客户机会处理这个问题，因为默认情况下FastAPI返回JSONResponse，还有其他响应类型，比如StreamingResponse，FileResponse，HTMLResponseetc（您可以从这里阅读常见的内容类型）。

查询参数和路径参数之间的主要区别在于，它们可以从URL访问，并且是字符串。但身体通常是携带数据的。

想象一下，您有一个更大的应用程序，并且正在使用Queryparams来进行客户端和服务器之间的所有通信。这将是一场彻底的灾难。

例如，现在你正在阅读这个答案，对吗？但它是怎么来的？你的身份证、名声和问题本身的所有细节都以身体的形式出现。想象一下，把这一切都发送到URL中，简直是灾难。

为了进一步阅读，您可以查看这些答案，以了解设计REST API的最佳实践。

• REST API最佳实践：参数放在哪里