# FastAPI CLI { #fastapi-cli } **FastAPI CLI** 是一個命令列程式,你可以用它來啟動你的 FastAPI 應用程式、管理你的 FastAPI 專案,等等。 當你安裝 FastAPI(例如使用 `pip install "fastapi[standard]"`)時,會附帶一個可以在終端機執行的命令列程式。 要在開發時運行你的 FastAPI 應用程式,你可以使用 `fastapi dev` 指令:
```console $ fastapi dev FastAPI Starting development server 🚀 Searching for package file structure from directories with __init__.py files Importing from /home/user/code/awesomeapp module 🐍 main.py code Importing the FastAPI app object from the module with the following code: from main import app app Using import string: main:app server Server started at http://127.0.0.1:8000 server Documentation at http://127.0.0.1:8000/docs tip Running in development mode, for production use: fastapi run Logs: INFO Will watch for changes in these directories: ['/home/user/code/awesomeapp'] INFO Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) INFO Started reloader process [383138] using WatchFiles INFO Started server process [383153] INFO Waiting for application startup. INFO Application startup complete. ```
/// tip 在生產環境請改用 `fastapi run`,不要用 `fastapi dev`。🚀 /// 在內部,**FastAPI CLI** 使用 [Uvicorn](https://www.uvicorn.dev),這是一個高效能、適用於生產環境的 ASGI 伺服器。😎 `fastapi` CLI 會嘗試自動偵測要執行的 FastAPI 應用程式,預設假設它是檔案 `main.py` 中名為 `app` 的物件(或其他幾種變體)。 不過你也可以明確設定要使用的 app。 ## 在 `pyproject.toml` 中設定應用程式的 `entrypoint` { #configure-the-app-entrypoint-in-pyproject-toml } 你可以在 `pyproject.toml` 檔案中指定你的 app 位置,例如: ```toml [tool.fastapi] entrypoint = "main:app" ``` 這個 `entrypoint` 會告訴 `fastapi` 指令應該像這樣匯入 app: ```python from main import app ``` 如果你的程式碼結構是這樣: ``` . ├── backend │   ├── main.py │   ├── __init__.py ``` 那麼你應該把 `entrypoint` 設為: ```toml [tool.fastapi] entrypoint = "backend.main:app" ``` 這等同於: ```python from backend.main import app ``` ### 帶路徑的 `fastapi dev` { #fastapi-dev-with-path } 你也可以把檔案路徑傳給 `fastapi dev` 指令,它會推測要使用的 FastAPI app 物件: ```console $ fastapi dev main.py ``` 但這樣每次呼叫 `fastapi` 指令時都得記得傳入正確的路徑。 此外,其他工具可能找不到它,例如 [VS Code 擴充套件](editor-support.md) 或 [FastAPI Cloud](https://fastapicloud.com),因此建議在 `pyproject.toml` 中使用 `entrypoint`。 ## `fastapi dev` { #fastapi-dev } 執行 `fastapi dev` 會啟動開發模式。 預設情況下,**auto-reload** 功能是啟用的,當你對程式碼進行修改時,伺服器會自動重新載入。這會消耗較多資源,並且可能比禁用時更不穩定。因此,你應該只在開發環境中使用此功能。它也會在 IP 位址 `127.0.0.1` 上監聽,這是用於你的機器與自身通訊的 IP 位址(`localhost`)。 ## `fastapi run` { #fastapi-run } 執行 `fastapi run` 會以生產模式啟動 FastAPI。 預設情況下,**auto-reload** 功能是禁用的。它也會在 IP 位址 `0.0.0.0` 上監聽,表示會監聽所有可用的 IP 位址,這樣任何能與該機器通訊的人都可以公開存取它。這通常是你在生產環境中運行應用程式的方式,例如在容器中運行時。 在大多數情況下,你會(也應該)有一個「終止代理」在外層幫你處理 HTTPS;這取決於你如何部署應用程式,你的服務供應商可能會幫你處理,或者你需要自己設置。 /// tip 你可以在[部署文件](deployment/index.md)中了解更多相關資訊。 ///