summaryrefslogtreecommitdiff
path: root/src/docs
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2018-07-27 04:10:16 +0900
committersyuilo <syuilotan@yahoo.co.jp>2018-07-27 04:10:16 +0900
commit0595d87759fe01a569a4716adfd99cd875d30460 (patch)
treef195370a8ec1cb300210878e415ba4e9bd410ec9 /src/docs
parentログインしていないとリバーシを観戦できない問題を修正 (diff)
downloadsharkey-0595d87759fe01a569a4716adfd99cd875d30460.tar.gz
sharkey-0595d87759fe01a569a4716adfd99cd875d30460.tar.bz2
sharkey-0595d87759fe01a569a4716adfd99cd875d30460.zip
Update doc
Diffstat (limited to 'src/docs')
-rw-r--r--src/docs/stream.ja.md41
1 files changed, 40 insertions, 1 deletions
diff --git a/src/docs/stream.ja.md b/src/docs/stream.ja.md
index 7a2815dba2..1ad36c9020 100644
--- a/src/docs/stream.ja.md
+++ b/src/docs/stream.ja.md
@@ -16,4 +16,43 @@
## ストリームを経由してAPIリクエストする
-ストリームを経由してAPIリクエストすると、HTTPリクエストを発生させずにAPIを利用できます。
+ストリームを経由してAPIリクエストすると、HTTPリクエストを発生させずにAPIを利用できます。そのため、コードを簡潔にできたり、パフォーマンスの向上を見込めるかもしれません。
+
+ストリームを経由してAPIリクエストするには、次のようなメッセージをストリームに送信します:
+```json
+{
+ type: 'api',
+ id: 'xxxxxxxxxxxxxxxx',
+ endpoint: 'notes/create',
+ data: {
+ text: 'yee haw!'
+ }
+}
+```
+
+`id`には、APIのレスポンスを識別するための、APIリクエストごとの一意なIDを設定する必要があります。UUIDや、簡単な乱数のようなもので構いません。
+
+`endpoint`には、あなたがリクエストしたいAPIのエンドポイントを指定します。
+
+`data`には、エンドポイントのパラメータを含めます。
+
+<div class="ui info">
+ <p><i class="fas fa-info-circle"></i> APIのエンドポイントやパラメータについてはAPIリファレンスをご確認ください。</p>
+</div>
+
+### レスポンスの受信
+
+APIへリクエストすると、レスポンスがストリームから次のような形式で流れてきます。
+
+```json
+{
+ type: 'api-res:xxxxxxxxxxxxxxxx',
+ body: {
+ ...
+ }
+}
+```
+
+`xxxxxxxxxxxxxxxx`の部分には、リクエストの際に設定された`id`が含まれています。これにより、どのリクエストに対するレスポンスなのか判別することができます。
+
+`body`には、レスポンスが含まれています。