教學 - 使用者指南¶
本教學將逐步示範如何使用 FastAPI 的大部分功能。
每個章節都會逐步建立在前一個章節的基礎上,但主題是各自獨立的,因此您可以直接跳到任何特定章節以解決您的特定 API 需求。
它也設計成方便日後參考,讓您可以隨時回來查看您需要的內容。
執行程式碼¶
所有程式碼區塊都可以直接複製使用(它們實際上是經過測試的 Python 檔案)。
要執行任何範例,請將程式碼複製到名為 main.py
的檔案中,然後使用以下指令啟動 fastapi dev
:
$ <font color="#4E9A06">fastapi</font> dev <u style="text-decoration-style:single">main.py</u>
<font color="#3465A4">INFO </font> Using path <font color="#3465A4">main.py</font>
<font color="#3465A4">INFO </font> Resolved absolute path <font color="#75507B">/home/user/code/awesomeapp/</font><font color="#AD7FA8">main.py</font>
<font color="#3465A4">INFO </font> Searching for package file structure from directories with <font color="#3465A4">__init__.py</font> files
<font color="#3465A4">INFO </font> Importing from <font color="#75507B">/home/user/code/</font><font color="#AD7FA8">awesomeapp</font>
╭─ <font color="#8AE234"><b>Python module file</b></font> ─╮
│ │
│ 🐍 main.py │
│ │
╰──────────────────────╯
<font color="#3465A4">INFO </font> Importing module <font color="#4E9A06">main</font>
<font color="#3465A4">INFO </font> Found importable FastAPI app
╭─ <font color="#8AE234"><b>Importable FastAPI app</b></font> ─╮
│ │
│ <span style="background-color:#272822"><font color="#FF4689">from</font></span><span style="background-color:#272822"><font color="#F8F8F2"> main </font></span><span style="background-color:#272822"><font color="#FF4689">import</font></span><span style="background-color:#272822"><font color="#F8F8F2"> app</font></span><span style="background-color:#272822"> </span> │
│ │
╰──────────────────────────╯
<font color="#3465A4">INFO </font> Using import string <font color="#8AE234"><b>main:app</b></font>
<span style="background-color:#C4A000"><font color="#2E3436">╭────────── FastAPI CLI - Development mode ───────────╮</font></span>
<span style="background-color:#C4A000"><font color="#2E3436">│ │</font></span>
<span style="background-color:#C4A000"><font color="#2E3436">│ Serving at: http://127.0.0.1:8000 │</font></span>
<span style="background-color:#C4A000"><font color="#2E3436">│ │</font></span>
<span style="background-color:#C4A000"><font color="#2E3436">│ API docs: http://127.0.0.1:8000/docs │</font></span>
<span style="background-color:#C4A000"><font color="#2E3436">│ │</font></span>
<span style="background-color:#C4A000"><font color="#2E3436">│ Running in development mode, for production use: │</font></span>
<span style="background-color:#C4A000"><font color="#2E3436">│ │</font></span>
<span style="background-color:#C4A000"><font color="#2E3436">│ </font></span><span style="background-color:#C4A000"><font color="#555753"><b>fastapi run</b></font></span><span style="background-color:#C4A000"><font color="#2E3436"> │</font></span>
<span style="background-color:#C4A000"><font color="#2E3436">│ │</font></span>
<span style="background-color:#C4A000"><font color="#2E3436">╰─────────────────────────────────────────────────────╯</font></span>
<font color="#4E9A06">INFO</font>: Will watch for changes in these directories: ['/home/user/code/awesomeapp']
<font color="#4E9A06">INFO</font>: Uvicorn running on <b>http://127.0.0.1:8000</b> (Press CTRL+C to quit)
<font color="#4E9A06">INFO</font>: Started reloader process [<font color="#34E2E2"><b>2265862</b></font>] using <font color="#34E2E2"><b>WatchFiles</b></font>
<font color="#4E9A06">INFO</font>: Started server process [<font color="#06989A">2265873</font>]
<font color="#4E9A06">INFO</font>: Waiting for application startup.
<font color="#4E9A06">INFO</font>: Application startup complete.
</pre>
強烈建議您自行編寫或複製程式碼、編輯並在本機執行。
在您的編輯器中使用它,才能真正體會到 FastAPI 的優勢,例如只需編寫少量程式碼、完整的型別檢查、自動完成等等。
安裝 FastAPI¶
第一步是安裝 FastAPI。
請確保您建立了一個虛擬環境,並將其啟動,然後**安裝 FastAPI**
$ pip install "fastapi[standard]"
---> 100%
注意事項
當您使用 pip install "fastapi[standard]"
安裝時,它會附帶一些預設的標準選用依賴項。
如果您不想要這些選用依賴項,您可以改用 pip install fastapi
安裝。
進階使用者指南¶
除了本篇**教學 - 使用者指南**之外,還有一份**進階使用者指南**,您可以稍後閱讀。
**進階使用者指南**建立在本指南的基礎上,使用相同的概念,並教您一些額外功能。
但您應該先閱讀**教學 - 使用者指南**(也就是您現在正在閱讀的內容)。
它的設計讓您只需閱讀**教學 - 使用者指南**即可建立完整的應用程式,然後根據您的需求,使用**進階使用者指南**中的一些額外概念來擴展它。