Skip to content

Game API

ninja03 edited this page Apr 27, 2021 · 1 revision

ゲーム作成

任意のボードでゲームを作成することが出来ます。

URL

POST /api/game/create

パラメータJSON

以下のパラメータを含んだJSONをbodyに入れて送信して下さい。

Name Type Discription
name
任意
string ゲーム名
boardName
必須
string ボード名
使用できるボード名はボード情報取得APIにて取得できます。
nPlayer
任意
number 参加人数(既定は2人です)
playerIndentifiers
任意
string[] ゲームに参加できるユーザの指定
ユーザネームorユーザIDの配列にしてください。
tournamentId
任意
string 所属する大会ID

パラメータJSONの例

{
  "name":"〇〇vs△△",
  "boardName":"A-1",
}

レスポンス

レスポンスのBodyにGameオブジェクトが返ってきます。

エラーレスポンス

以下のエラーレスポンスが返ってるくる可能性があります。エラーレスポンスについてはError Responseを見てください。

204 302 400 401


ボード情報取得

サーバで使用可能な全てのボード情報を取得できます。

URL

GET /api/game/boards

レスポンス

レスポンスのBodyにBoardオブジェクトの配列が返ってきます。


Clone this wiki locally