committed by
GitHub
3 changed files with 72 additions and 0 deletions
@ -0,0 +1,31 @@ |
|||
# 响应 - 更改状态码 |
|||
|
|||
你可能之前已经了解到,你可以设置默认的[响应状态码](../tutorial/response-status-code.md){.internal-link target=_blank}。 |
|||
|
|||
但在某些情况下,你需要返回一个不同于默认值的状态码。 |
|||
|
|||
## 使用场景 |
|||
|
|||
例如,假设你想默认返回一个HTTP状态码为“OK”`200`。 |
|||
|
|||
但如果数据不存在,你想创建它,并返回一个HTTP状态码为“CREATED”`201`。 |
|||
|
|||
但你仍然希望能够使用`response_model`过滤和转换你返回的数据。 |
|||
|
|||
对于这些情况,你可以使用一个`Response`参数。 |
|||
|
|||
## 使用 `Response` 参数 |
|||
|
|||
你可以在你的*路径操作函数*中声明一个`Response`类型的参数(就像你可以为cookies和头部做的那样)。 |
|||
|
|||
然后你可以在这个*临时*响应对象中设置`status_code`。 |
|||
|
|||
```Python hl_lines="1 9 12" |
|||
{!../../../docs_src/response_change_status_code/tutorial001.py!} |
|||
``` |
|||
|
|||
然后你可以像平常一样返回任何你需要的对象(例如一个`dict`或者一个数据库模型)。如果你声明了一个`response_model`,它仍然会被用来过滤和转换你返回的对象。 |
|||
|
|||
**FastAPI**将使用这个临时响应来提取状态码(也包括cookies和头部),并将它们放入包含你返回的值的最终响应中,该响应由任何`response_model`过滤。 |
|||
|
|||
你也可以在依赖项中声明`Response`参数,并在其中设置状态码。但请注意,最后设置的状态码将会生效。 |
@ -0,0 +1,39 @@ |
|||
# 响应头 |
|||
|
|||
## 使用 `Response` 参数 |
|||
|
|||
你可以在你的*路径操作函数*中声明一个`Response`类型的参数(就像你可以为cookies做的那样)。 |
|||
|
|||
然后你可以在这个*临时*响应对象中设置头部。 |
|||
```Python hl_lines="1 7-8" |
|||
{!../../../docs_src/response_headers/tutorial002.py!} |
|||
``` |
|||
|
|||
然后你可以像平常一样返回任何你需要的对象(例如一个`dict`或者一个数据库模型)。如果你声明了一个`response_model`,它仍然会被用来过滤和转换你返回的对象。 |
|||
|
|||
**FastAPI**将使用这个临时响应来提取头部(也包括cookies和状态码),并将它们放入包含你返回的值的最终响应中,该响应由任何`response_model`过滤。 |
|||
|
|||
你也可以在依赖项中声明`Response`参数,并在其中设置头部(和cookies)。 |
|||
|
|||
## 直接返回 `Response` |
|||
|
|||
你也可以在直接返回`Response`时添加头部。 |
|||
|
|||
按照[直接返回响应](response-directly.md){.internal-link target=_blank}中所述创建响应,并将头部作为附加参数传递: |
|||
```Python hl_lines="10-12" |
|||
{!../../../docs_src/response_headers/tutorial001.py!} |
|||
``` |
|||
|
|||
|
|||
!!! 注意 "技术细节" |
|||
你也可以使用`from starlette.responses import Response`或`from starlette.responses import JSONResponse`。 |
|||
|
|||
**FastAPI**提供了与`fastapi.responses`相同的`starlette.responses`,只是为了方便开发者。但是,大多数可用的响应都直接来自Starlette。 |
|||
|
|||
由于`Response`经常用于设置头部和cookies,因此**FastAPI**还在`fastapi.Response`中提供了它。 |
|||
|
|||
## 自定义头部 |
|||
|
|||
请注意,可以使用'X-'前缀添加自定义专有头部。 |
|||
|
|||
但是,如果你有自定义头部,你希望浏览器中的客户端能够看到它们,你需要将它们添加到你的CORS配置中(在[CORS(跨源资源共享)](../tutorial/cors.md){.internal-link target=_blank}中阅读更多),使用在<a href="https://www.starlette.io/middleware/#corsmiddleware" class="external-link" target="_blank">Starlette的CORS文档</a>中记录的`expose_headers`参数。 |
Loading…
Reference in new issue