Skip to content

Commit f0d59e5

Browse files
Zhongheng-ChengZhongheng-Cheng
authored
🌐 Update Chinese translation for docs/zh/docs/tutorial/first-steps.md (fastapi#13348)
1 parent cbd7d48 commit f0d59e5

File tree

1 file changed

+41
-54
lines changed

1 file changed

+41
-54
lines changed

‎docs/zh/docs/tutorial/first-steps.md

Lines changed: 41 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -11,34 +11,49 @@
1111
<div class="termy">
1212

1313
```console
14-
$ uvicorn main:app --reload
14+
$ <font color="#4E9A06">fastapi</font> dev <u style="text-decoration-style:solid">main.py</u>
1515

16-
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
17-
<span style="color: green;">INFO</span>: Started reloader process [28720]
18-
<span style="color: green;">INFO</span>: Started server process [28722]
19-
<span style="color: green;">INFO</span>: Waiting for application startup.
20-
<span style="color: green;">INFO</span>: Application startup complete.
21-
```
16+
<span style="background-color:#009485"><font color="#D3D7CF"> FastAPI </font></span> Starting development server 🚀
2217

23-
</div>
18+
Searching for package file structure from directories
19+
with <font color="#3465A4">__init__.py</font> files
20+
Importing from <font color="#75507B">/home/user/code/</font><font color="#AD7FA8">awesomeapp</font>
2421

25-
/// note
22+
<span style="background-color:#007166"><font color="#D3D7CF"> module </font></span> 🐍 main.py
2623

27-
`uvicorn main:app` 命令含义如下:
24+
<span style="background-color:#007166"><font color="#D3D7CF"> code </font></span> Importing the FastAPI app object from the module with
25+
the following code:
2826

29-
* `main`：`main.py` 文件（一个 Python「模块」）。
30-
* `app`：在 `main.py` 文件中通过 `app = FastAPI()` 创建的对象。
31-
* `--reload`：让服务器在更新代码后重新启动。仅在开发时使用该选项。
27+
<u style="text-decoration-style:solid">from </u><u style="text-decoration-style:solid"><b>main</b></u><u style="text-decoration-style:solid"> import </u><u style="text-decoration-style:solid"><b>app</b></u>
3228

33-
///
29+
<span style="background-color:#007166"><font color="#D3D7CF"> app </font></span> Using import string: <font color="#3465A4">main:app</font>
30+
31+
<span style="background-color:#007166"><font color="#D3D7CF"> server </font></span> Server started at <font color="#729FCF"><u style="text-decoration-style:solid">http://127.0.0.1:8000</u></font>
32+
<span style="background-color:#007166"><font color="#D3D7CF"> server </font></span> Documentation at <font color="#729FCF"><u style="text-decoration-style:solid">http://127.0.0.1:8000/docs</u></font>
33+
34+
<span style="background-color:#007166"><font color="#D3D7CF"> tip </font></span> Running in development mode, for production use:
35+
<b>fastapi run</b>
36+
37+
Logs:
38+
39+
<span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span> Will watch for changes in these directories:
40+
<b>[</b><font color="#4E9A06">&apos;/home/user/code/awesomeapp&apos;</font><b>]</b>
41+
<span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span> Uvicorn running on <font color="#729FCF"><u style="text-decoration-style:solid">http://127.0.0.1:8000</u></font> <b>(</b>Press CTRL+C
42+
to quit<b>)</b>
43+
<span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span> Started reloader process <b>[</b><font color="#34E2E2"><b>383138</b></font><b>]</b> using WatchFiles
44+
<span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span> Started server process <b>[</b><font color="#34E2E2"><b>383153</b></font><b>]</b>
45+
<span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span> Waiting for application startup.
46+
<span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span> Application startup complete.
47+
```
48+
49+
</div>
3450

3551
在输出中，会有一行信息像下面这样：
3652

3753
```hl_lines="4"
3854
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
3955
```
4056

41-
4257
该行显示了你的应用在本机所提供服务的 URL 地址。
4358

4459
### 查看
@@ -63,7 +78,7 @@ INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
6378

6479
前往 <a href="http://127.0.0.1:8000/redoc" class="external-link" target="_blank">http://127.0.0.1:8000/redoc</a>。
6580

66-
你将会看到可选的自动生成文档 （由 <a href="https://github.com/Rebilly/ReDoc" class="external-link" target="_blank">ReDoc</a> 提供)：
81+
你将会看到可选的自动生成文档 （由 <a href="https://github.com/Rebilly/ReDoc" class="external-link" target="_blank">ReDoc</a> 提供）：
6782

6883
![ReDoc](https://fastapi.tiangolo.com/img/index/index-02-redoc-simple.png)
6984

@@ -77,9 +92,9 @@ INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
7792

7893
#### API「模式」
7994

80-
在这种场景下，OpenAPI 是一种规定如何定义 API 模式的规范。
95+
在这种场景下，<a href="https://github.com/OAI/OpenAPI-Specification" class="external-link" target="_blank">OpenAPI</a> 是一种规定如何定义 API 模式的规范。
8196

82-
定义的 OpenAPI 模式将包括你的 API 路径，以及它们可能使用的参数等等。
97+
「模式」的定义包括你的 API 路径，以及它们可能使用的参数等等。
8398

8499
#### 数据「模式」
85100

@@ -93,15 +108,15 @@ OpenAPI 为你的 API 定义 API 模式。该模式中包含了你的 API 发送
93108

94109
#### 查看 `openapi.json`
95110

96-
如果你对原始的 OpenAPI 模式长什么样子感到好奇，其实它只是一个自动生成的包含了所有 API 描述的 JSON。
111+
如果你对原始的 OpenAPI 模式长什么样子感到好奇，FastAPI 自动生成了包含所有 API 描述的 JSON（模式）。
97112

98113
你可以直接在：<a href="http://127.0.0.1:8000/openapi.json" class="external-link" target="_blank">http://127.0.0.1:8000/openapi.json</a> 看到它。
99114

100115
它将显示以如下内容开头的 JSON：
101116

102117
```JSON
103118
{
104-
"openapi": "3.0.2",
119+
"openapi": "3.1.0",
105120
"info": {
106121
"title": "FastAPI",
107122
"version": "0.1.0"
@@ -140,7 +155,7 @@ OpenAPI 为你的 API 定义 API 模式。该模式中包含了你的 API 发送
140155

141156
`FastAPI` 是直接从 `Starlette` 继承的类。
142157

143-
你可以通过 `FastAPI` 使用所有的 Starlette 的功能。
158+
你可以通过 `FastAPI` 使用所有的 <a href="https://www.starlette.io/" class="external-link" target="_blank">Starlette</a> 的功能。
144159

145160
///
146161

@@ -152,34 +167,6 @@ OpenAPI 为你的 API 定义 API 模式。该模式中包含了你的 API 发送
152167

153168
这个实例将是创建你所有 API 的主要交互对象。
154169

155-
这个 `app` 同样在如下命令中被 `uvicorn` 所引用：
156-
157-
<div class="termy">
158-
159-
```console
160-
$ uvicorn main:app --reload
161-
162-
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
163-
```
164-
165-
</div>
166-
167-
如果你像下面这样创建应用：
168-
169-
{* ../../docs_src/first_steps/tutorial002.py hl[3] *}
170-
171-
将代码放入 `main.py` 文件中，然后你可以像下面这样运行 `uvicorn`：
172-
173-
<div class="termy">
174-
175-
```console
176-
$ uvicorn main:my_awesome_api --reload
177-
178-
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
179-
```
180-
181-
</div>
182-
183170
### 步骤 3：创建一个*路径操作*
184171

185172
#### 路径
@@ -279,13 +266,13 @@ https://example.com/items/foo
279266

280267
/// tip
281268

282-
您可以随意使用任何一个操作（HTTP方法）。
269+
你可以随意使用任何一个操作（HTTP方法）。
283270

284271
**FastAPI** 没有强制要求操作有任何特定的含义。
285272

286273
此处提供的信息仅作为指导，而不是要求。
287274

288-
比如，当使用 GraphQL 时通常你所有的动作都通过 `post` 一种方法执行。
275+
比如，当使用 GraphQL 时通常你所有的动作都通过 `POST` 一种方法执行。
289276

290277
///
291278

@@ -331,6 +318,6 @@ https://example.com/items/foo
331318

332319
* 导入 `FastAPI`。
333320
* 创建一个 `app` 实例。
334-
* 编写一个**路径操作装饰器**（如 `@app.get("/")`）。
335-
* 编写一个**路径操作函数**（如上面的 `def root(): ...`）。
336-
* 运行开发服务器（如 `uvicorn main:app --reload`）。
321+
* 编写一个**路径操作装饰器**，如 `@app.get("/")`。
322+
* 定义一个**路径操作函数**，如 `def root(): ...`。
323+
* 使用命令 `fastapi dev` 运行开发服务器。

0 commit comments

Comments
 (0)