Thanks to visit codestin.com
Credit goes to github.com

Skip to content

🌐 Update Chinese translation for docs/tutorial/response-status-code.md #3498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tiangolo merged 4 commits into from
Mar 30, 2024
Merged

🌐 Update Chinese translation for docs/tutorial/response-status-code.md #3498

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1c74a85
Update Chinese translation for tutorial response-status-code.md
jaystone776 Jul 7, 2021
5cd0702
Update response-status-code.md
jaystone776 Sep 1, 2021
83a2dac
Merge branch 'master' into Update-Chinese-translation-for-tutorial-re…
tiangolo Jun 26, 2023
1ba166a
🎨 [pre-commit.ci] Auto format from pre-commit.com hooks
pre-commit-ci[bot] Jun 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 47 additions & 41 deletions docs/zh/docs/tutorial/response-status-code.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,89 +1,95 @@
# 响应状态码

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

* `@app.get()`
* `@app.post()`
* `@app.put()`
* `@app.delete()`
* 等等。
* 等……

```Python hl_lines="6"
{!../../../docs_src/response_status_code/tutorial001.py!}
```

!!! note
注意，`status_code` 是「装饰器」方法（`get`，`post` 等）的一个参数。不像之前的所有参数和请求体，它不属于*路径操作函数*。
!!! note "笔记"

`status_code` 参数接收一个表示 HTTP 状态码的数字。
注意，`status_code` 是（`get`、`post` 等）**装饰器**方法中的参数。与之前的参数和请求体不同，不是*路径操作函数*的参数。

!!! info
`status_code` 也能够接收一个 `IntEnum` 类型，比如 Python 的 <a href="https://docs.python.org/3/library/http.html#http.HTTPStatus" class="external-link" target="_blank">`http.HTTPStatus`</a>。
`status_code` 参数接收表示 HTTP 状态码的数字。

它将会：
!!! info "说明"

* 在响应中返回该状态码。
* 在 OpenAPI 模式中（以及在用户界面中）将其记录为：
`status_code` 还能接收 `IntEnum` 类型，比如 Python 的 <a href="https://docs.python.org/3/library/http.html#http.HTTPStatus" class="external-link" target="_blank">`http.HTTPStatus`</a>。

<img src="https://fastapi.tiangolo.com/img/tutorial/response-status-code/image01.png">
它可以：

!!! note
一些响应状态码（请参阅下一部分）表示响应没有响应体。
* 在响应中返回状态码
* 在 OpenAPI 概图（及用户界面）中存档：

FastAPI 知道这一点，并将生成表明没有响应体的 OpenAPI 文档。
<img src="/img/tutorial/response-status-code/image01.png">

!!! note "笔记"

某些响应状态码表示响应没有响应体（参阅下一章）。

FastAPI 可以进行识别，并生成表明无响应体的 OpenAPI 文档。

## 关于 HTTP 状态码

!!! note
如果你已经了解什么是 HTTP 状态码，请跳到下一部分。
!!! note "笔记"

在 HTTP 协议中，你将发送 3 位数的数字状态码作为响应的一部分。
如果已经了解 HTTP 状态码，请跳到下一章。

这些状态码有一个识别它们的关联名称，但是重要的还是数字。
在 HTTP 协议中，发送 3 位数的数字状态码是响应的一部分。

简而言之：
这些状态码都具有便于识别的关联名称，但是重要的还是数字。

* `100` 及以上状态码用于「消息」响应。你很少直接使用它们。具有这些状态代码的响应不能带有响应体。
* **`200`** 及以上状态码用于「成功」响应。这些是你最常使用的。
* `200` 是默认状态代码，它表示一切「正常」。
* 另一个例子会是 `201`，「已创建」。它通常在数据库中创建了一条新记录后使用。
* 一个特殊的例子是 `204`，「无内容」。此响应在没有内容返回给客户端时使用，因此该响应不能包含响应体。
* **`300`** 及以上状态码用于「重定向」。具有这些状态码的响应可能有或者可能没有响应体，但 `304`「未修改」是个例外，该响应不得含有响应体。
* **`400`** 及以上状态码用于「客户端错误」响应。这些可能是你第二常使用的类型。
* 一个例子是 `404`，用于「未找到」响应。
* 对于来自客户端的一般错误，你可以只使用 `400`。
* `500` 及以上状态码用于服务器端错误。你几乎永远不会直接使用它们。当你的应用程序代码或服务器中的某些部分出现问题时，它将自动返回这些状态代码之一。
简言之：

!!! tip
要了解有关每个状态代码以及适用场景的更多信息，请查看 <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" class="external-link" target="_blank"><abbr title="Mozilla Developer Network">MDN</abbr> 关于 HTTP 状态码的文档</a>。
* `100` 及以上的状态码用于返回**信息**。这类状态码很少直接使用。具有这些状态码的响应不能包含响应体
* **`200`** 及以上的状态码用于表示**成功**。这些状态码是最常用的
* `200` 是默认状态代码，表示一切**正常**
* `201` 表示**已创建**，通常在数据库中创建新记录后使用
* `204` 是一种特殊的例子，表示**无内容**。该响应在没有为客户端返回内容时使用，因此，该响应不能包含响应体
* **`300`** 及以上的状态码用于**重定向**。具有这些状态码的响应不一定包含响应体，但 `304`**未修改**是个例外，该响应不得包含响应体
* **`400`** 及以上的状态码用于表示**客户端错误**。这些可能是第二常用的类型
* `404`，用于**未找到**响应
* 对于来自客户端的一般错误，可以只使用 `400`
* `500` 及以上的状态码用于表示服务器端错误。几乎永远不会直接使用这些状态码。应用代码或服务器出现问题时，会自动返回这些状态代码

## 记住名称的捷径
!!! tip "提示"

让我们再次看看之前的例子：
状态码及适用场景的详情，请参阅 <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" class="external-link" target="_blank"><abbr title="Mozilla Developer Network">MDN 的 HTTP 状态码</abbr>文档</a>。

## 状态码名称快捷方式

再看下之前的例子：

```Python hl_lines="6"
{!../../../docs_src/response_status_code/tutorial001.py!}
```

`201` 是表示「已创建」的状态码。
`201` 表示**已创建**的状态码。

但是你不必去记住每个代码的含义。
但我们没有必要记住所有代码的含义。

你可以使用来自 `fastapi.status` 的便捷变量。
可以使用 `fastapi.status` 中的快捷变量。

```Python hl_lines="1 6"
{!../../../docs_src/response_status_code/tutorial002.py!}
```

它们只是一种便捷方式，它们具有同样的数字代码，但是这样使用你就可以使用编辑器的自动补全功能来查找它们：
这只是一种快捷方式，具有相同的数字代码，但它可以使用编辑器的自动补全功能：

<img src="https://fastapi.tiangolo.com/img/tutorial/response-status-code/image02.png">
<img src="../../../../../../img/tutorial/response-status-code/image02.png">

!!! note "技术细节"
你也可以使用 `from starlette import status`。

为了给你（即开发者）提供方便，**FastAPI** 提供了与 `starlette.status` 完全相同的 `fastapi.status`。但它直接来自于 Starlette。
也可以使用 `from starlette import status`。

为了让开发者更方便，**FastAPI** 提供了与 `starlette.status` 完全相同的 `fastapi.status`。但它直接来自于 Starlette。

## 更改默认状态码

稍后，在[高级用户指南](../advanced/response-change-status-code.md){.internal-link target=_blank}中你将了解如何返回与在此声明的默认状态码不同的状态码。
[高级用户指南](../advanced/response-change-status-code.md){.internal-link target=_blank}中，将介绍如何返回与在此声明的默认状态码不同的状态码。