12 KiB
自定义响应 - HTML、流、文件等
FastAPI 默认会使用 JSONResponse 返回响应。
你可以通过直接返回 Response 来重载它，参见 直接返回响应{.internal-link target=_blank}。
但如果你直接返回一个 Response（或其任意子类，比如 JSONResponse），返回数据不会自动转换（即使你声明了 response_model），也不会自动生成文档（例如，在生成的 OpenAPI 中，HTTP 头 Content-Type 里的特定「媒体类型」不会被包含）。
你还可以在 路径操作装饰器 中通过 response_class 参数声明要使用的 Response（例如任意 Response 子类）。
你从 路径操作函数 中返回的内容将被放在该 Response 中。
并且如果该 Response 有一个 JSON 媒体类型（application/json），比如使用 JSONResponse 或 UJSONResponse 的时候，返回的数据将使用你在路径操作装饰器中声明的任何 Pydantic 的 response_model 自动转换（和过滤）。
/// note | 注意
如果你使用不带有任何媒体类型的响应类，FastAPI 会认为你的响应没有任何内容，所以不会在生成的 OpenAPI 文档中记录响应格式。
///
使用 ORJSONResponse
例如，如果你需要压榨性能，你可以安装并使用 orjson 并将响应设置为 ORJSONResponse。
导入你想要使用的 Response 类（子类）然后在 路径操作装饰器 中声明它。
对于较大的响应，直接返回一个 Response 会比返回一个字典快得多。
这是因为默认情况下，FastAPI 会检查其中的每一项并确保它可以被序列化为 JSON，使用教程中解释的相同 JSON 兼容编码器{.internal-link target=_blank}。这正是它允许你返回「任意对象」的原因，例如数据库模型。
但如果你确定你返回的内容是「可以用 JSON 序列化」的，你可以将它直接传给响应类，从而避免在传给响应类之前先通过 jsonable_encoder 带来的额外开销。
{* ../../docs_src/custom_response/tutorial001b_py39.py hl[2,7] *}
/// info | 信息
参数 response_class 也会用来定义响应的「媒体类型」。
在这个例子中，HTTP 头的 Content-Type 会被设置成 application/json。
并且在 OpenAPI 文档中也会这样记录。
///
/// tip | 提示
ORJSONResponse 目前只在 FastAPI 中可用，而在 Starlette 中不可用。
///
HTML 响应
使用 HTMLResponse 来从 FastAPI 中直接返回一个 HTML 响应。
- 导入
HTMLResponse。 - 将
HTMLResponse作为你的 路径操作 的response_class参数传入。
{* ../../docs_src/custom_response/tutorial002_py39.py hl[2,7] *}
/// info | 信息
参数 response_class 也会用来定义响应的「媒体类型」。
在这个例子中，HTTP 头的 Content-Type 会被设置成 text/html。
并且在 OpenAPI 文档中也会这样记录。
///
返回一个 Response
正如你在 直接返回响应{.internal-link target=_blank} 中了解到的，你也可以通过直接返回响应在 路径操作 中直接重载响应。
和上面一样的例子，返回一个 HTMLResponse 看起来可能是这样：
{* ../../docs_src/custom_response/tutorial003_py39.py hl[2,7,19] *}
/// warning | 警告
路径操作函数 直接返回的 Response 不会被 OpenAPI 的文档记录（比如，Content-Type 不会被文档记录），并且在自动化交互文档中也是不可见的。
///
/// info | 信息
当然，实际的 Content-Type 头、状态码等等，将来自于你返回的 Response 对象。
///
在 OpenAPI 中文档化并重载 Response
如果你想要在函数内重载响应，但是同时在 OpenAPI 中文档化「媒体类型」，你可以使用 response_class 参数并返回一个 Response 对象。
接着 response_class 参数只会被用来文档化 OpenAPI 的 路径操作，你的 Response 用来返回响应。
直接返回 HTMLResponse
比如像这样：
{* ../../docs_src/custom_response/tutorial004_py39.py hl[7,21,23] *}
在这个例子中，函数 generate_html_response() 已经生成并返回 Response 对象而不是在 str 中返回 HTML。
通过返回函数 generate_html_response() 的调用结果，你已经返回一个重载 FastAPI 默认行为的 Response 对象。
但如果你在 response_class 中也传入了 HTMLResponse，FastAPI 会知道如何在 OpenAPI 和交互式文档中使用 text/html 将其文档化为 HTML：
可用响应
这里有一些可用的响应。
要记得你可以使用 Response 来返回任何其他东西，甚至创建一个自定义的子类。
/// note | 技术细节
你也可以使用 from starlette.responses import HTMLResponse。
FastAPI 提供了同 fastapi.responses 相同的 starlette.responses 只是为了方便开发者。但大多数可用的响应都直接来自 Starlette。
///
Response
其他全部的响应都继承自主类 Response。
你可以直接返回它。
Response 类接受如下参数：
content- 一个str或者bytes。status_code- 一个int类型的 HTTP 状态码。headers- 一个由字符串组成的dict。media_type- 一个给出媒体类型的str，比如"text/html"。
FastAPI（实际上是 Starlette）将自动包含 Content-Length 的头。它还将包含一个基于 media_type 的 Content-Type 头，并为文本类型附加一个字符集。
{* ../../docs_src/response_directly/tutorial002_py39.py hl[1,18] *}
HTMLResponse
如上文所述，接受文本或字节并返回 HTML 响应。
PlainTextResponse
接受文本或字节并返回纯文本响应。
{* ../../docs_src/custom_response/tutorial005_py39.py hl[2,7,9] *}
JSONResponse
接受数据并返回一个 application/json 编码的响应。
如上文所述，这是 FastAPI 中使用的默认响应。
ORJSONResponse
如上文所述，ORJSONResponse 是一个使用 orjson 的快速的可选 JSON 响应。
/// info | 信息
这需要先安装 orjson，例如使用 pip install orjson。
///
UJSONResponse
UJSONResponse 是一个使用 ujson 的可选 JSON 响应。
/// info | 信息
这需要先安装 ujson，例如使用 pip install ujson。
///
/// warning | 警告
在处理某些边缘情况时，ujson 不如 Python 的内置实现那么谨慎。
///
{* ../../docs_src/custom_response/tutorial001_py39.py hl[2,7] *}
/// tip | 提示
ORJSONResponse 可能是一个更快的选择。
///
RedirectResponse
返回 HTTP 重定向。默认情况下使用 307 状态码（临时重定向）。
你可以直接返回一个 RedirectResponse：
{* ../../docs_src/custom_response/tutorial006_py39.py hl[2,9] *}
或者你可以把它用于 response_class 参数：
{* ../../docs_src/custom_response/tutorial006b_py39.py hl[2,7,9] *}
如果你这么做，那么你可以在 路径操作 函数中直接返回 URL。
在这种情况下，将使用 RedirectResponse 的默认 status_code，即 307。
你也可以将 status_code 参数和 response_class 参数结合使用：
{* ../../docs_src/custom_response/tutorial006c_py39.py hl[2,7,9] *}
StreamingResponse
采用异步生成器或普通生成器/迭代器，然后流式传输响应主体。
{* ../../docs_src/custom_response/tutorial007_py39.py hl[2,14] *}
对类似文件的对象使用 StreamingResponse
如果您有一个类文件对象（例如由 open() 返回的对象），你可以创建一个生成器函数来迭代该类文件对象。
这样，你就不必先把它全部读入内存，可以将该生成器函数传给 StreamingResponse 并返回它。
这也包括许多与云存储、视频处理等交互的库。
{* ../../docs_src/custom_response/tutorial008_py39.py hl[2,10:12,14] *}
-
这是生成器函数。之所以是「生成器函数」，是因为它内部包含
yield语句。 -
通过使用
with代码块，我们可以确保在生成器函数完成后关闭类文件对象。因此，在它完成发送响应之后会被关闭。 -
这个
yield from告诉函数去迭代名为file_like的那个对象。然后，对于每个被迭代出来的部分，都把该部分作为来自这个生成器函数（iterfile）的值再yield出去。因此，它是一个把「生成」工作内部转交给其他东西的生成器函数。
通过这种方式，我们可以把它放在
with代码块中，从而确保类文件对象在结束后被关闭。
/// tip | 提示
注意在这里，因为我们使用的是不支持 async 和 await 的标准 open()，我们使用普通的 def 声明了路径操作。
///
FileResponse
异步传输文件作为响应。
与其他响应类型相比，接受不同的参数集进行实例化：
path- 要流式传输的文件的文件路径。headers- 任何自定义响应头，传入字典类型。media_type- 给出媒体类型的字符串。如果未设置，则文件名或路径将用于推断媒体类型。filename- 如果给出，它将包含在响应的Content-Disposition中。
文件响应将包含适当的 Content-Length、Last-Modified 和 ETag 响应头。
{* ../../docs_src/custom_response/tutorial009_py39.py hl[2,10] *}
你也可以使用 response_class 参数：
{* ../../docs_src/custom_response/tutorial009b_py39.py hl[2,8,10] *}
在这种情况下，你可以在 路径操作 函数中直接返回文件路径。
自定义响应类
你可以创建你自己的自定义响应类，继承自 Response 并使用它。
例如，假设你想使用 orjson，但要使用内置 ORJSONResponse 类没有启用的一些自定义设置。
假设你想让它返回带缩进、格式化的 JSON，因此你想使用 orjson 选项 orjson.OPT_INDENT_2。
你可以创建一个 CustomORJSONResponse。你需要做的主要事情是实现一个返回 bytes 的 Response.render(content) 方法：
{* ../../docs_src/custom_response/tutorial009c_py39.py hl[9:14,17] *}
现在，不再是返回：
{"message": "Hello World"}
…这个响应将返回：
{
"message": "Hello World"
}
当然，你很可能会找到比格式化 JSON 更好的方式来利用这一点。😉
默认响应类
在创建 FastAPI 类实例或 APIRouter 时，你可以指定默认要使用的响应类。
用于定义它的参数是 default_response_class。
在下面的示例中，FastAPI 会在所有 路径操作 中默认使用 ORJSONResponse，而不是 JSONResponse。
{* ../../docs_src/custom_response/tutorial010_py39.py hl[2,4] *}
/// tip | 提示
你仍然可以像之前一样在 路径操作 中重载 response_class。
///
额外文档
你还可以使用 responses 在 OpenAPI 中声明媒体类型和许多其他详细信息：OpenAPI 中的额外文档{.internal-link target=_blank}。