ストレージへのアップロード、取得APIについての検討

[marihachi]

静止画、動画、音声
細かなエンドポイント設計は後々

とりあえずは、静止画のアップロードに絞って検討していきます

[marihachi]

ストレージのリソースを

• /storages/:storageId
• /users/:userId/storage

どちらにおくかという問題で、
前者の /storages/:storageId に置くのであれば、user以外のエンティティがストレージを持つことになったとき(例えば、groupなど)に、そのstorageIdが user と group のどちらが所有するものかを判断する必要が出てくきて実装が煩雑になると予想できる。
そのため、後者の /users/:userId/storage に置く方針でいくことになりました。

追記(2018/2/3)
これでも、userエンティティとそれ以外のエンティティがそれぞれストレージを持つことになったとして、両者ともDBのstorageFilesコレクションに保存されるので結局creator.type ("user" や "group")を保存することにはなるんだけどね。
ファイルはファイルなので、作成者の種類(user,group)に関係なく統一して扱われる方が、取り出し操作もしやすいかなという考えのもとでの判断です。

[marihachi]

エンドポイントを模索中
以下のような感じになりそう

操作	エンドポイント	備考
ストレージの状態取得	GET /users/:userId/storage #95
新規作成	POST /users/:userId/storage/files #90
ファイル一覧の取得	GET /users/:userId/storage/files #91	フィルター指定可能
対象ファイルの取得	GET /users/:userId/storage/files/:file_id #92
対象ファイルの削除	DELETE /users/:userId/storage/files/:file_id #93

ファイルデータはbase64にエンコードしてアップロードします
(2018/2/3 編集済み)

[marihachi]

ストレージの残りの容量を取得したいときなどに今のエンドポイント設計だと整合が取れないな
ファイルに関する操作のベースを /users/:userId/storage/files に変更しようかな
それでストレージの状態取得、ストレージ自身に関する情報取得は GET /users/:userId/storage でできるように

[karamelle]

これ投稿とかに紐付けたとき、投稿からファイル情報を取得するときにどのエンドポイント叩くといいのか気になる
投稿のデータにすべて含むので問題ないということならいいのだけれど

[marihachi]

ポストにはファイルid(もしくは ファイルid+ファイルデータ)を持たせると思う。
任意のタイミングで紐付いたファイルを取得したいときには、
GET /users/(ユーザーid)/storage/files/(ファイルid)
にアクセスすることになるかと思うよ

事前にポストエンティティにファイルデータを埋め込んで返すかどうかについては要検討だけどね

[marihachi]

現時点で考えているファイルへのアクセス権:

• public: 全体公開
• specific: フォロワーであるか、ユーザーを個別指定 などをOR条件で設定
• private: 非公開

[marihachi]

ファイルのアクセス権の設計を変更
specificをprivateに統合して、publicとprivateの２種類にします。

[marihachi]

• base64エンコードされたファイルのアップロードと取得
• 公開範囲をprivate(非公開)として限定公開するユーザーを指定した時に、所有者と指定したユーザーがアクセスできるか、逆に他のユーザーがアクセス出来ないか

この２つが確認できたので、結構良い所まで来ています。