-
Notifications
You must be signed in to change notification settings - Fork 1
API設計
Averak edited this page Oct 18, 2022
·
22 revisions
詳細はSwagger UIを参照してください。
/api/health
GET
/api/rooms
POST
/api/rooms/{room_id}/join
POST
詳細はasyncapi.yml
を参照してください。
/app/rooms/{room_id}/timer/start
{
"value": number, // タイマー時間を秒単位で指定(例:15分なら900にする)
}
/app/rooms/{room_id}/timer/resume
{
"value": number, // 残り時間を秒単位で指定
}
/app/rooms/{room_id}/timer/stop
/app/rooms/{room_id}/timer/reset
/app/rooms/{room_id}/slides/next
/app/rooms/{room_id}/slides/previous
/app/rooms/{room_id}/pointer/control
{
alpha: number,
beta: number,
beta: gamma,
}
/app/rooms/{room_id}/pointer/disconnect
/topic/rooms/{room_id}/users
{
users: [
{
id: string,
name: string,
}
]
}
/topic/rooms/{room_id}/timer
{
value: number, // 初期値[s]
finish_at: date, // 終了予定日時(READY中は当てにならん数値)
status: number, // ステータスIDが入る(0: READY、1: RUNNING)
}
/topic/rooms/{room_id}/slides/control
{
control: number // スライド操作ID(0: NEXT、1: PREVIOUS)
}
rotation
は、ポインター切断イベントを配信する場合(=enabled
がfalseの場合)のみnullになる。
/topic/rooms/{room_id}/pointer/control
{
user: {
id: string,
name: string,
},
enabled: boolean, // ポインター表示フラグ(ポインターボタンを離したら、これがfalseになる)
rotation: { // NULLABLなセンサ値
alpha: number,
beta: number,
beta: gamma,
}
}
ユーザのpub処理に失敗した場合に、本トピックから例外を対象ユーザのみに配信します。
/topic/exception
{
code: number,
message: string,
}