建立 fastapi 專案開發環境

這篇主要是建立基本環境，和執行環境的說明。

安裝所需套件

pip install fastapi
pip install uvicorn  # ASGI server
pip install gunicorn  # WSGI server

在專案中撰寫測試的程式：

from fastapi import FastAPI

app = FastAPI()

@app.get('/hello')
def hello():
  return {"say": "hello"}

直接使用 uvicorn 執行：

uvicorn main:app --reload --port 8888

執行後可以在 http://localhost:8888/docs 看到 openAPI document。

gnuicorn 搭配 uvicorn 執行：

gunicorn main:app -b 0.0.0.0:8888 -k uvicorn.workers.UvicornWorker

# 下式為背景執行
gunicorn main:app -b 0.0.0.0:8888 -k uvicorn.workers.UvicornWorker --daemon

# 背景執行時若要停下來，可以使用下式查看 pid 再使用 kill 移除 proccess
ps -ef | grep gunicorn

如果環境中有安裝 PM2 (Nodejs 行程管理工具) 也可以使用 PM2 啟動行程。

pm2 --name=gunicorn start "gunicorn main:app -b 0.0.0.0:8888 -k uvicorn.workers.UvicornWorker"

使用 conda 建立 python 虛擬環境

查看所有的虛擬環境

conda env list

使用預設的 python 版本建立環境，下式的 myenv 為虛擬環境的名稱。

conda create -n myenv

使用指定的 python 版本建立環境。

conda create -n myenv python=3.10

啟用某個環境

conda activate myenv
# conda deactivate  #退出某個環境
pip install --upgrade pip # 確保 pip 是最新的版本

安裝套件

pip install fastapi
pip install uvicorn
# pip install python-multipart  # uvicorn 安裝時會自動安裝 python-multipart