APIの仕様の変更

[nyamadori]

現行のAPI仕様がRESTfulではなかったので、美しいRESTful APIを提案

• POST /api/sessions
  • 概要: セッションを作成
  • リクエスト:
  • name: ユーザ名
  • レスポンス: Object
  • userId: セッションとして使用するユーザID
• POST /api/rooms/:id/answers
  • 概要: ルームに対して回答を送信する
  • パラメータ:
  • id: ルームID
  • リクエスト:
  • locationName: 地名
  • phonetic: 地名の読み (ひらがな)
  • userId: ユーザID
  • レスポンス:
  • nextStartWith: 次に応えるべき単語の頭の文字 (お題)
  • result: 回答結果
• POST /api/rooms
  • 概要: 新しいルームを作る
  • リクエスト:
  • name: ルーム名
  • gameMode: ゲームモード
• GET /api/rooms
  • 概要: ルームの一覧を作成する
  • レスポンス: 配列
  • name: ルーム名
  • gameMode: ゲームモード

[nyamadori]

:+1:

[TakuyaKanehira]

提案を承諾します。 変更しておきます。

[TakuyaKanehira]

POST /api/roomsのレスポンスにroomIdは返さなくていいのか？

[nyamadori]

@TakuyaKanehira あー必要ですね。コレクションの各オブジェクトに対してはidつけててほしい。 /api/roomsなら、roomIdとせずにidでいいと思う。 ただ、外部キーの場合は単にidとすると主キーと区別がつかないからhogehoge_idとつけてほしい。

[TakuyaKanehira]

御意