UnityクライアントとFastAPIサーバーを連携させた、シンプルなランキング機能のサンプル実装です。
Unityからユーザー名とスコアを送信し、サーバー側でPostgreSQLに保存します。 保存されたスコアはランキングとして取得でき、Unityクライアント上で表示できます。 Docker ComposeでAPIサーバー、DB、Adminer（データベースの確認用）を起動する想定です。
- Unityクライアントからスコアを登録
- スコア順のランキングを取得
- 登録したスコアの順位を取得（同点スコアは同順位として扱う）
- PostgreSQLにランキングデータを保存
- Unity 2022.3.14f1
- FastAPI / Python
- PostgreSQL
- SQLModel
- Docker / Docker Compose
- Adminer
- Docker Compose (サーバー用)
- Unity 2022.3.14f1 (クライアント用)
このプロジェクトでは、APIサーバー、PostgreSQL、AdminerをDocker Composeで起動します。
初回は .env を作成してから、Docker Composeを実行してください。
unity-ranking-api\.env.example をコピーして unity-ranking-api\.env を作成します。
リポジトリ直下でDocker Composeを実行します。
docker compose upサーバー起動後は以下にアクセスすることができます。
- API:
http://localhost:8080 - Swagger UI:
http://localhost:8080/docs - Adminer:
http://localhost:8081
Unity Hubから以下のプロジェクトを開きます。
unity-client/ranking-clientUnityからサーバーのAPIにアクセスすることができます。
以下でコンテナを停止することができます。
docker compose down
PostgreSQLのデータは名前付きvolume postgres-data に保存されます。
通常の docker compose down では削除されません。
コンテナとDBデータをまとめて削除する場合はコンテナ停止時に以下を実行します。
docker compose down -v
サンプルシーンは、Assets/Scenes/RankingClientScene.unityです。
こちらのシーンでは、APIとの通信を確認することができる簡単なサンプルを実行することができます。
なお、デフォルトのAPI接続先はhttp://localhost:8080となっています。Ranking Client ControllerコンポーネントのApi Base Urlを変更することで、接続先を変更することもできます。
APIサーバーの動作確認用エンドポイントです。
Response:
{
"message": "Hello World"
}FastAPIからPostgreSQLへ接続できるか確認します。
Response:
{
"database": "ok"
}スコアを登録します。
Request:
{
"username": "test_player",
"score": 1234
}Response:
{
"username": "test_player",
"score": 1234,
"id": 1
}スコアの高い順にランキングを取得します。
limit を省略した場合は最大100件を返します。
limit の最大値は500です。
Example:
http://localhost:8080/ranking?limit=10Response:
[
{
"username": "ore",
"score": 12345,
"id": 1
},
{
"username": "Nova",
"score": 9870,
"id": 2
}
]登録済みスコアの順位を取得します。 同じスコアは同順位として扱います。
Example:
http://localhost:8080/scores/1/rankResponse:
{
"username": "test_player",
"score": 1234,
"id": 1,
"rank": 10
}データベースに登録するためのサンプルデータを準備しています。
以下を実行することで、デフォルトのサンプルデータserver/seed_data/sample_scores.jsonをデータベースに登録することができます。
docker compose exec api python seed.py
--clearをつけることで、既存のスコアを削除してから、サンプルスコアを投入します。
docker compose exec api python seed.py --clear
また次のように指定することで、特定のjsonファイルを指定して、データベースを登録することもできます。
docker compose exec api python seed.py json_filename
server/seed_data/sample_scores.jsonの他にserver/seed_data/manual_test_scores.json も用意しています。こちらは、AdminerやUnityクライアントから手動入力するときの参考データです。(seed.pyを利用して、登録することもできます。)
Adminerは以下のURLから利用できます。
http://localhost:8081接続情報は.envに依存しており、デフォルト設定の場合の接続情報は以下のようになります。
System: PostgreSQL
Server: db
Username: postgres
Password: example_password
Database: rankingこのリポジトリには、Dev Container設定を含めています。
Dev Containerでは /workspace を開き、サーバーディレクトリを /app にマウントします。
/workspace
リポジトリ全体
/app
FastAPIサーバーのディレクトリVS Codeから以下を実行します。
Dev Containers: Rebuild and Reopen in Container