junnetworks/house_administrator

アドミニストレータ様になれます.

house_administrator's Issues

APIのURL設計

一応今考えているのは, APIのURLは api/ で始まる.

そんで, 例えばJUNの部屋のエアコンの気温上げる場合には api/jun_room/air_conditioner みたいな.

しかし, 今までのようなAPIじゃなくて, gRPCを使ってAPI作ってみてもいいかもしれん.

フロントのURL設計

APIのURL設計の修正案

現在基本的にAPIのURLは /rooms/:RoomID/... のような形式で, センサーや測定情報, コントローラー全てがこの部屋のIDから始まっている形式になっている.

しかし, 普通に /sensors/:SensorID などの方が良い気がしてきた.

この形式だと /sensors/ で全センサー取得出来るし, 綺麗にURLが設計出来る気がする.

新しい API URL設計

• / : 未定

部屋

• GET /rooms : 部屋一覧
• POST /rooms : 部屋追加
• GET /rooms/:roomID: 部屋情報の取得
• PUT /rooms/:roomID: 部屋情報の更新
• DELETE /rooms/:roomID: 部屋の削除

センサー

• GET /sensors: 全てのセンサーの情報を取得. (部屋やセンサータイプなどの条件でフィルター出来るようにする)
• POST /sensors: センサーを追加 (どの部屋に所属するかなどはHTTPのBodyに載せる)
• GET /sensors/:sensorID: 特定のセンサーの情報を取得
• PUT /sensors/:sensorID: 特定のセンサーを更新

計測データ

• DELETE /rooms/:roomID/sensors/:sensorID: 特定のセンサーを削除
• GET /sensors/:sensorID/measurements: 特定のセンサーが記録した記録を返す
• POST /sensors/:sensorID/measurements: 特定のセンサーの記録を記録する
• GET /sensors/:sensorID/measurements/latest: 特定のセンサーの最新の記録を返す

コントローラー

• GET /controllers: 全てのコントローラーを取得 (部屋やセンサータイプなどの条件でフィルター出来るようにする)
• POST /controllers: 新しいコントローラーを登録する
• GET /controllers/:controllerID: 特定のコントローラーの情報を取得

コマンド

• GET /controllers/:controllerID/commands: 特定のコントローラーのコマンドを全て取得
• POST /controllers/:controllerID/commands: 特定のコントローラーにコマンドを追加
• GET /controllers/:controllerID/commands/:commandID: コマンド情報の取得
• POST /controllers/:controllerID/commands/:commandID/execute: コマンド実行 (HTTPのボディは基本空)
• PUT /controllers/:controllerID/commands/:commandID: コマンドを更新
• DELETE /controllers/:controllerID/commands/:commandID: コマンドを削除

フロントのデザイン

とりあえずは装飾なしでも良いかもしれんが...