|
1 | 1 | # 教程 - 用户指南
|
2 | 2 |
|
3 |
| -本教程将一步步向你展示如何使用 **FastAPI** 的绝大部分特性。 |
| 3 | +本教程将一步步向您展示如何使用 **FastAPI** 的绝大部分特性。 |
4 | 4 |
|
5 |
| -各个章节的内容循序渐进,但是又围绕着单独的主题,所以你可以直接跳转到某个章节以解决你的特定需求。 |
| 5 | +各个章节的内容循序渐进,但是又围绕着单独的主题,所以您可以直接跳转到某个章节以解决您的特定需求。 |
6 | 6 |
|
7 |
| -本教程同样可以作为将来的参考手册。 |
8 |
| - |
9 |
| -你可以随时回到本教程并查阅你需要的内容。 |
| 7 | +本教程同样可以作为将来的参考手册,所以您可以随时回到本教程并查阅您需要的内容。 |
10 | 8 |
|
11 | 9 | ## 运行代码
|
12 | 10 |
|
13 | 11 | 所有代码片段都可以复制后直接使用(它们实际上是经过测试的 Python 文件)。
|
14 | 12 |
|
15 |
| -要运行任何示例,请将代码复制到 `main.py` 文件中,然后使用以下命令启动 `uvicorn`: |
| 13 | +要运行任何示例,请将代码复制到 `main.py` 文件中,然后使用以下命令启动 `fastapi dev`: |
16 | 14 |
|
17 | 15 | <div class="termy">
|
18 | 16 |
|
19 | 17 | ```console
|
20 |
| -$ uvicorn main:app --reload |
| 18 | +$ <font color="#4E9A06">fastapi</font> dev <u style="text-decoration-style:solid">main.py</u> |
| 19 | + |
| 20 | + <span style="background-color:#009485"><font color="#D3D7CF"> FastAPI </font></span> Starting development server 🚀 |
| 21 | + |
| 22 | + Searching for package file structure from directories |
| 23 | + with <font color="#3465A4">__init__.py</font> files |
| 24 | + Importing from <font color="#75507B">/home/user/code/</font><font color="#AD7FA8">awesomeapp</font> |
| 25 | + |
| 26 | + <span style="background-color:#007166"><font color="#D3D7CF"> module </font></span> 🐍 main.py |
| 27 | + |
| 28 | + <span style="background-color:#007166"><font color="#D3D7CF"> code </font></span> Importing the FastAPI app object from the module with |
| 29 | + the following code: |
| 30 | + |
| 31 | + <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> |
| 32 | + |
| 33 | + <span style="background-color:#007166"><font color="#D3D7CF"> app </font></span> Using import string: <font color="#3465A4">main:app</font> |
| 34 | + |
| 35 | + <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> |
| 36 | + <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> |
| 37 | + |
| 38 | + <span style="background-color:#007166"><font color="#D3D7CF"> tip </font></span> Running in development mode, for production use: |
| 39 | + <b>fastapi run</b> |
| 40 | + |
| 41 | + Logs: |
21 | 42 |
|
22 |
| -<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) |
23 |
| -<span style="color: green;">INFO</span>: Started reloader process [28720] |
24 |
| -<span style="color: green;">INFO</span>: Started server process [28722] |
25 |
| -<span style="color: green;">INFO</span>: Waiting for application startup. |
26 |
| -<span style="color: green;">INFO</span>: Application startup complete. |
| 43 | + <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span> Will watch for changes in these directories: |
| 44 | + <b>[</b><font color="#4E9A06">'/home/user/code/awesomeapp'</font><b>]</b> |
| 45 | + <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 |
| 46 | + to quit<b>)</b> |
| 47 | + <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 |
| 48 | + <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> |
| 49 | + <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span> Waiting for application startup. |
| 50 | + <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span> Application startup complete. |
27 | 51 | ```
|
28 | 52 |
|
29 | 53 | </div>
|
30 | 54 |
|
31 |
| -强烈建议你在本地编写或复制代码,对其进行编辑并运行。 |
| 55 | +**强烈建议**您在本地编写或复制代码,对其进行编辑并运行。 |
32 | 56 |
|
33 | 57 | 在编辑器中使用 FastAPI 会真正地展现出它的优势:只需要编写很少的代码,所有的类型检查,代码补全等等。
|
34 | 58 |
|
35 | 59 | ---
|
36 | 60 |
|
37 | 61 | ## 安装 FastAPI
|
38 | 62 |
|
39 |
| -第一个步骤是安装 FastAPI。 |
| 63 | +第一个步骤是安装 FastAPI. |
40 | 64 |
|
41 |
| -为了使用本教程,你可能需要安装所有的可选依赖及对应功能: |
| 65 | +请确保您创建并激活一个[虚拟环境](../virtual-environments.md){.internal-link target=_blank},然后**安装 FastAPI**: |
42 | 66 |
|
43 | 67 | <div class="termy">
|
44 | 68 |
|
45 | 69 | ```console
|
46 |
| -$ pip install "fastapi[all]" |
| 70 | +$ pip install "fastapi[standard]" |
47 | 71 |
|
48 | 72 | ---> 100%
|
49 | 73 | ```
|
50 | 74 |
|
51 | 75 | </div>
|
52 | 76 |
|
53 |
| -......以上安装还包括了 `uvicorn`,你可以将其用作运行代码的服务器。 |
54 |
| - |
55 | 77 | /// note
|
56 | 78 |
|
57 |
| -你也可以分开来安装。 |
58 |
| - |
59 |
| -假如你想将应用程序部署到生产环境,你可能要执行以下操作: |
60 |
| - |
61 |
| -``` |
62 |
| -pip install fastapi |
63 |
| -``` |
64 |
| - |
65 |
| -并且安装`uvicorn`来作为服务器: |
66 |
| - |
67 |
| -``` |
68 |
| -pip install "uvicorn[standard]" |
69 |
| -``` |
| 79 | +当您使用 `pip install "fastapi[standard]"` 进行安装时,它会附带一些默认的可选标准依赖项。 |
70 | 80 |
|
71 |
| -然后对你想使用的每个可选依赖项也执行相同的操作。 |
| 81 | +如果您不想安装这些可选依赖,可以选择安装 `pip install fastapi`。 |
72 | 82 |
|
73 | 83 | ///
|
74 | 84 |
|
75 | 85 | ## 进阶用户指南
|
76 | 86 |
|
77 |
| -在本**教程-用户指南**之后,你可以阅读**进阶用户指南**。 |
| 87 | +在本**教程-用户指南**之后,您可以阅读**进阶用户指南**。 |
78 | 88 |
|
79 | 89 | **进阶用户指南**以本教程为基础,使用相同的概念,并教授一些额外的特性。
|
80 | 90 |
|
81 |
| -但是你应该先阅读**教程-用户指南**(即你现在正在阅读的内容)。 |
| 91 | +但是您应该先阅读**教程-用户指南**(即您现在正在阅读的内容)。 |
82 | 92 |
|
83 |
| -教程经过精心设计,使你可以仅通过**教程-用户指南**来开发一个完整的应用程序,然后根据你的需要,使用**进阶用户指南**中的一些其他概念,以不同的方式来扩展它。 |
| 93 | +教程经过精心设计,使您可以仅通过**教程-用户指南**来开发一个完整的应用程序,然后根据您的需要,使用**进阶用户指南**中的一些其他概念,以不同的方式来扩展它。 |
0 commit comments