New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support stream API #1

Open

eniehack opened this issue Sep 20, 2019 · 1 comment

Labels

Milestone

Member

eniehack commented Sep 20, 2019

Summary

v1.0.0までにストリーミングAPIが欲しい
エンドポイントはどこにするのか
Bodyはどのような型にするのか
- どのようなものをストリーミングAPIで提供するのか(メディアをストリーミングAPIに流すのかなど)
ストリーミングとして最適な規格は何があるのか
- WebSocket
- Server-Sent Event

Merit

クライアント側が無駄なポーリングをせずに済む
サーバ側も無駄なレスポンスをせずに済む

Demerit

ライブラリを探す必要がある
実装に時間がかかる？

eniehack added the enhancement label

eniehack added this to the v1.0.0 milestone

Member Author

eniehack commented Sep 20, 2019 •

edited

Loading

My proposal

エンドポイントは/api/v1/stream/以下にする
- WebSocket(WS)の場合は単一エンドポイント
- Server-Sent Eventの場合は複数エンドポイント？
使用規格はライブラリの豊富さで比較して考える
- MastodonはSSEとWS両方提供している
- JSではSSEもWSも標準でサポートしている
BodyはREST APIと同じ型でメディアファイルはURLを提供
WebSocketについて: MDN
Server-Sent Eventについて: MDN

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment