プロジェクトの準備

このページで扱う手順で、必要なパッケージをまとめてインストールします。すでにインストール済みのパッケージがある場合は、自動的にスキップされるだけなので、そのまま実行して問題ありません。

1. パッケージのインストール

以下のコマンドで、必要なパッケージをまとめてインストールします。すでにインストール済みのパッケージがある場合は、自動的にスキップされるだけなので、そのまま実行して問題ありません。

Windowsの場合:

pip install fastapi uvicorn sqlmodel pymysql python-dotenv

Macの場合:

pip3 install fastapi uvicorn sqlmodel pymysql python-dotenv

ここで、今回インストールした各ライブラリの役割を確認しておきましょう。

ライブラリ 役割
FastAPI PythonでREST APIを構築するためのWebフレームワーク
uvicorn FastAPIアプリケーションを動かすためのASGI対応Webサーバ
SQLModel Pythonのクラスでデータベースのテーブルを扱えるようにするORM
PyMySQL PythonからMySQLに接続するためのドライバ
python-dotenv .envファイルから環境変数を読み込むためのライブラリ
⚠️ 「WARNING: You are using pip version ...」と表示される場合
これはpip自体のバージョンが古いことを知らせる警告です。パッケージのインストール自体は正常に完了しているため、この警告は無視して問題ありません。気になる場合は、表示されたコマンド(python3 -m pip install --upgrade pip)を実行するとpipを最新版に更新できます。

2. フォルダとファイルの作成

本章では、まず任意の場所にnote-apiフォルダを作成します。

note-api/  ← このフォルダを作成

作成したフォルダをVisual Studio Codeで開きます。Visual Studio Codeのメニューから「ファイル」→「フォルダーを開く」を選択し、作成したフォルダを開いてください。

本章では、以下のファイル構成でプロジェクトを作成します。

note-api/
├── main.py            ← アプリケーションの起動設定
├── models.py          ← SQLModelのモデル定義
├── database.py        ← データベース接続の設定
├── setup_db.py        ← テーブル作成・テストデータ挿入
├── routers/           ← このフォルダを作成
│   └── notes.py       ← ノートAPIのエンドポイント
└── .env               ← 環境変数

前の章ではすべてのコードをmain.pyにまとめていましたが、本章ではファイルを役割ごとに分割して管理します。特にエンドポイントはrouters/フォルダに分離しています。これはFastAPI公式ドキュメントのBigger Applicationsで推奨されている構成で、実際のプロジェクトでもこのようにファイルを分けることで、コードの見通しがよくなり保守がしやすくなります。

まず、環境変数を管理するための.envファイルを作成します。Visual Studio Codeのエクスプローラーでnote-apiフォルダを右クリックし、「新しいファイル」を選択して.envという名前で作成してください。

note-api/
└── .env  ← このファイルを作成

作成したファイルに以下の内容を記述して保存します。

DB_HOST=localhost
DB_USER=root
DB_PASSWORD=your_password
DB_NAME=notedb
💡 ポイント
DB_PASSWORDには、MySQLのインストール時に設定したrootパスワードを指定してください。本章のコード例ではyour_passwordと記載していますが、ご自身のパスワードに置き換えてください。
💡 ポイント
.envファイルにはパスワードなどの機密情報を記載します。チーム開発ではGitリポジトリにコミットしないよう、.gitignoreに.envを追加してください。

3. データベースの作成

前の章と同様に、データベース自体の作成はMySQL CLIから行います。

以下のコマンドで、MySQL がインストールされていることを確認します。

mysql --version

以下のように MySQL のバージョンが表示されれば、インストールは確認できています。

mysql  Ver 8.0.xx for macos on arm64 (MySQL Community Server - GPL)

バージョンが表示されない場合は、MySQLのインストール を先に実施してください。

インストールが確認できたら、以下のコマンドでデータベースを作成します。

mysql -u root -p -e "CREATE DATABASE notedb;"

パスワードを入力すると、データベースnotedbが作成されます。データベースが正しく作成されたことを確認します。

mysql -u root -p -e "SHOW DATABASES;"

パスワードを入力すると、データベースの一覧が表示されます。

+--------------------+
| Database           |
+--------------------+
| information_schema |
| mysql              |
| notedb             |
| performance_schema |
| sys                |
+--------------------+

一覧にnotedbが含まれていれば成功です。