🤹

FastAPI 環境構築

2024/01/23に公開

FastAPI 環境構築を説明していきます。
ざっくりな流れとして、、、
PCにPython入れる (pyenv)

仮想環境を作る (venv)

必要なものをインストールする (pip)

(サーバーはuvicornを使う)

Pythonをインストールする

https://original-game.com/python_course/install/mac-homebrew-pyenv/
この記事を参考にして、Pythonをインストールする。
(pyenvを使ってバージョン管理をしています。)

pyenv -v

そしてpyenvを使って、Pythonをインストールします。

使うことができるPythonのバージョンを一覧で確認
pyenv install --list
pyenv install 3.10.5
pyenv versions

仮想環境

仮想環境とは、パソコンやストレージなどのハードウェア内で仮想的に構築された環境のことです。
つまり、、物理的には1つしかない環境を複数作る的な!!!

# 仮想環境を作成している
# 最後のvenvは環境名。この環境名にしておくことでgithubのgitignoreにpythonを指定した時に効率が良くなる。
python -m venv venv

# 仮想環境を有効化している
# venvの環境を有効化している形になっている
source  venv/bin/activate

仮想環境は、ベース Python とも呼ばれる、すでにインストールされている Python の上に作成され、明示的にインストールしたパッケージのみが利用可能となるよう、ベース Python から隔離することもできます。

https://docs.python.org/ja/3/library/venv.html

FastAPIインストール

pip install fastapi

pip install "uvicorn[standard]"
  • uvicornはfastapiを実行するサーバーのこと。
  • pipとはPythonのパッケージ管理ツールのこと。
  • この時にドキュメントも作成される

https://www.sejuku.net/blog/50417

まとめ

この様な流れで、FastAPIの環境構築が完成します。

 uvicorn main:app --reload
or
uvicorn app.main:app --reload
 uvicorn localhost:8000
 をターミナルに入力して、レスポンスを表示することができる。
 uvicorn localhost:8000/docs
 を入力して、ドキュメントを表示することができる。
pip list
# fastapiではエンドポイントは関数として定義する
# この関数は非同期関数として定義する
# デコレーターを使ってエンドポイントを定義する
@app.get("/")
async def test():
    return {"res": "Hello World"}

あとはこれでサーバーを立ち上げてしまえばいい。

Discussion