summaryrefslogtreecommitdiff
path: root/src/docs
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2018-07-27 05:58:52 +0900
committersyuilo <syuilotan@yahoo.co.jp>2018-07-27 05:58:52 +0900
commit32435e4d8efcf31ab40b59241423cfc25754ac97 (patch)
tree2f704cfddf122edb99d0b85cbc8c78f257f67f6b /src/docs
parentUpdate doc (diff)
downloadsharkey-32435e4d8efcf31ab40b59241423cfc25754ac97.tar.gz
sharkey-32435e4d8efcf31ab40b59241423cfc25754ac97.tar.bz2
sharkey-32435e4d8efcf31ab40b59241423cfc25754ac97.zip
Update docs
Diffstat (limited to 'src/docs')
-rw-r--r--src/docs/api.ja.md3
-rw-r--r--src/docs/stream.ja.md5
2 files changed, 8 insertions, 0 deletions
diff --git a/src/docs/api.ja.md b/src/docs/api.ja.md
index 22a491e4b0..c7a4ffc728 100644
--- a/src/docs/api.ja.md
+++ b/src/docs/api.ja.md
@@ -71,6 +71,9 @@ APIの詳しい使用法は「Misskey APIの利用」セクションをご覧く
## Misskey APIの利用
APIはすべてリクエストのパラメータ・レスポンスともにJSON形式です。また、すべてのエンドポイントはPOSTメソッドのみ受け付けます。
+
+ストリーミングAPIも提供しています。
+
APIリファレンスもご確認ください。
### レートリミット
diff --git a/src/docs/stream.ja.md b/src/docs/stream.ja.md
index 3122228df1..bbf4e48bc1 100644
--- a/src/docs/stream.ja.md
+++ b/src/docs/stream.ja.md
@@ -18,6 +18,11 @@
認証情報は、自分のAPIキーや、アプリケーションからストリームに接続する際はユーザーのアクセストークンのことを指します。
+<div class="ui info">
+ <p><i class="fas fa-info-circle"></i> 認証情報の取得については、<a href="./api">こちらのドキュメント</a>をご確認ください。</p>
+</div>
+
+
## ストリームを経由してAPIリクエストする
ストリームを経由してAPIリクエストすると、HTTPリクエストを発生させずにAPIを利用できます。そのため、コードを簡潔にできたり、パフォーマンスの向上を見込めるかもしれません。