バックエンド開発セットアップ¶

このページでは、Gramps Webのバックエンド（サーバーコンポーネント）であるGramps Web APIの開発を開始するために必要な手順をリストします。

前提条件¶

推奨される開発セットアップは、devcontainersを使用したVisual Studio Codeです。このアプローチでは、必要なすべてのツールを備えた事前構成された開発環境が作成されます。始めるには、以下の要素が必要です：

Docker
Visual Studio Code と Dev Containers 拡張機能がインストールされていること
Git

Linux、macOS、またはWindowsをオペレーティングシステムとして使用できます。

開始する¶

Gramps Web APIリポジトリを開き、「fork」をクリックします。
Gitを使用して、フォークしたリポジトリをローカルマシンにクローンします。
クローンしたリポジトリをVisual Studio Codeで開きます。プロンプトが表示されたら、「コンテナで再オープン」を選択するか、コマンドパレットを手動で開いて（Ctrl+Shift+PまたはCmd+Shift+P）、"Dev Containers: Rebuild and Reopen in Container"を選択します。
devコンテナがビルドされて起動するのを待ちます。特に初回は数分かかる場合があります。

Dev Containerのビルドが成功した後、コマンドは次のように返されます：

Successfully installed gramps-webapi-x.x.x.
Info

Visual Studio Codeでコンテナを再ビルドするには：
- コンテナ内にいる場合は、「コンテナ内で再ビルド」パレットコマンドを使用します。
- フォルダビュー（つまり、コンテナ内ではない）にいる場合は、「コンテナで再ビルドして再オープン」パレットコマンドを使用します。

タスク¶

バックエンドコードのみを変更する場合、Webサーバーを立ち上げる必要はありません - ユニットテストは、実行中のサーバーを必要とせずにAPIへのリクエストをシミュレートできるFlaskテストクライアントを使用します。

ただし、サーバーを実行することは、以下の理由で便利です：

実際のHTTPリクエストで変更を試したい場合（手動クエリを参照）
変更がGramps Webアプリケーション全体に与える影響をプレビューしたい場合、または
フロントエンドにも同時に変更を加えたい場合（フロントエンド開発セットアップを参照）。

サーバーの実行は、devコンテナ内で事前定義されたタスクによって簡素化されています。これらのタスクは、コマンドパレット（Ctrl+Shift+PまたはCmd+Shift+P）から「Tasks: Run Task」を選択し、次のいずれかを選ぶことで実行できます： - "Serve Web API" - デバッグログを有効にしてポート5555でFlask開発サーバーを起動します - "Start Celery worker" - バックグラウンドタスクを処理するCeleryワーカーを起動します。

デバッグ¶

デバッグは時に難しいことがあります。特に複雑な動作を追跡したり微妙な問題を特定したりする際には。これを容易にするために、実行中のAPIインスタンスと個々のテストケースをVisual Studio Code内で直接デバッグできます。

Gramps Web APIのデバッグ¶

実行中のAPIをデバッグするには：

Visual Studio Codeを開き、実行とデバッグビューに移動します。
ドロップダウンメニューから"Web API"構成を選択します。
デバッグを開始します。
バックエンドにリクエストを送信すると（手動またはGramps Web GUIを通じて）、コード内で設定したブレークポイントで実行が一時停止します。
これにより、変数、制御フロー、およびその他の実行時の詳細を検査できます。

テストケースのデバッグ¶

特定のテストケースをデバッグするには：

デバッグしたいテストファイルを開きます（例えば、test_people.py）。
Visual Studio Codeで実行とデバッグビューを開きます。
"Current Test File"構成を選択します。
デバッグを開始します — 実行は、そのテストファイル内で設定されたブレークポイントで停止します。

このセットアップにより、テストロジックをステップ実行し、変数の値を調べ、テストの失敗や予期しない結果をよりよく理解できます。