FastAPI 教程

FastAPI 提供了以下内容： 基于开放标准 用于创建 API 的 OpenAPI 包含了路径操作，请求参数，请求体，安全性等的声明。 使用&nbs…

Python 3.6+ 版本加入了对”类型提示”的支持。 这些”类型提示”是一种新的语法（在 Python 3.6 版本加入）用来声…

本教程将一步步向你展示如何使用 FastAPI 的绝大部分特性。 各个章节的内容循序渐进，但是又围绕着单独的主题，所以你可以直接跳转到某个章节以解决你的特定需求…

最简单的 FastAPI 文件可能像下面这样： from fastapi import FastAPI app = FastAPI() @app.get(“/”) async de…

你可以使用与 Python 格式化字符串相同的语法来声明路径”参数”或”变量”： from fastapi import FastA…

声明不属于路径参数的其他函数参数时，它们将被自动解释为”查询字符串”参数 from fastapi import FastAPI app = FastAPI…

当你需要将数据从客户端（例如浏览器）发送给 API 时，你将其作为「请求体」发送。 请求体是客户端发送给 API 的数据。响应体是 API 发送给客户端的数据。 你的 API 几乎…

FastAPI 允许你为参数声明额外的信息和校验。 让我们以下面的应用程序为例： from typing import Optional from fastapi imp…

与使用 Query 为查询参数声明更多的校验和元数据的方式相同，你也可以使用 Path 为路径参数声明相同类型的校验和元数据。 导入 Pat…

既然我们已经知道了如何使用 Path 和 Query，下面让我们来了解一下请求体声明的更高级用法。 混合使用 Path、Query&nbsp…

与使用 Query、Path 和 Body 在路径操作函数中声明额外的校验和元数据的方式相同，你可以使用 Pydantic 的 F…

使用 FastAPI，你可以定义、校验、记录文档并使用任意深度嵌套的模型（归功于Pydantic）。 List 字段 你可以将一个属性定义为拥有子元素的类型。例如 Pyt…

您可以在JSON模式中定义额外的信息。 一个常见的用例是添加一个将在文档中显示的example。 有几种方法可以声明额外的 JSON 模式信息。 Pydantic sch…

到目前为止，您一直在使用常见的数据类型，如: int float str bool 但是您也可以使用更复杂的数据类型。 您仍然会拥有现在已经看到的相同的特性: 很棒的编辑器支持。 …

你可以像定义 Query 参数和 Path 参数一样来定义 Cookie 参数。 导入 Cookie 首先，导…

你可以使用定义 Query, Path 和 Cookie 参数一样的方法定义 Header 参数。 导入 Header …

你可以在任意的路径操作中使用 response_model 参数来声明用于响应的模型： @app.get() @app.post() @app.put() @a…

我们从前面的示例继续，拥有多个相关的模型是很常见的。 对用户模型来说尤其如此，因为： 输入模型需要拥有密码属性。 输出模型不应该包含密码。 数据库模型很可能需要保存密码的哈希值。 …

与指定响应模型的方式相同，你也可以在以下任意的路径操作中使用 status_code 参数来声明用于响应的 HTTP 状态码： @app.get() @app.…

接收的不是 JSON，而是表单字段时，要使用 Form。 说明 要使用表单，需预先安装 python-multipart。 例如，pip install pyt…