summaryrefslogtreecommitdiff
path: root/src/docs/api
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2017-05-24 20:09:12 +0900
committersyuilo <syuilotan@yahoo.co.jp>2017-05-24 20:09:12 +0900
commit55cb58e4515247cf35691cf89c103cc209a4d8f5 (patch)
tree1d621f942819478bc7e5d1242ecafb9f783a5d0f /src/docs/api
parent#123 (diff)
downloadsharkey-55cb58e4515247cf35691cf89c103cc209a4d8f5.tar.gz
sharkey-55cb58e4515247cf35691cf89c103cc209a4d8f5.tar.bz2
sharkey-55cb58e4515247cf35691cf89c103cc209a4d8f5.zip
WIP #13
Diffstat (limited to 'src/docs/api')
-rw-r--r--src/docs/api/getting-started.md (renamed from src/docs/api/getting-started.pug)45
-rw-r--r--src/docs/api/library.md8
-rw-r--r--src/docs/api/library.pug14
3 files changed, 26 insertions, 41 deletions
diff --git a/src/docs/api/getting-started.pug b/src/docs/api/getting-started.md
index 2aa2822e42..e13659914e 100644
--- a/src/docs/api/getting-started.pug
+++ b/src/docs/api/getting-started.md
@@ -1,34 +1,25 @@
-extend ../BASE
+Getting Started
+================================================================
+MisskeyはREST APIやStreaming APIを提供しており、プログラムからMisskeyの全ての機能を利用することができます。
+それらのAPIを利用するには、まずAPIを利用したいアカウントのアクセストークンを取得する必要があります:
-block title
- | Getting Started
+自分のアクセストークンを取得したい場合
+----------------------------------------------------------------
+自分自身のアクセストークンは、設定 > API で確認できます。
+<p class="tip">
+ アカウントを乗っ取られてしまう可能性があるため、トークンは第三者に教えないでください(アプリなどにも入力しないでください)。<br>
+ 万が一トークンが漏れたりその可能性がある場合は トークンを再生成できます。(副作用として、ログインしているすべてのデバイスでログアウトが発生します)
+</p>
-block content
- h1 Getting Started
+他人のアクセストークンを取得する
+----------------------------------------------------------------
+不特定多数のユーザーからAPIを利用したい場合、アプリケーションを作成します。
+アプリケーションを作成すると、ユーザーが連携を許可した時に、そのユーザーのアクセストークンを取得することができます。
- p MisskeyはREST APIやStreaming APIを提供しており、プログラムからMisskeyの全ての機能を利用することができます。
- p それらのAPIを利用するには、まずAPIを利用したいアカウントのアクセストークンを取得する必要があります:
+アプリケーションを作成してアクセストークンを取得するまでの流れを説明します。
- section
- h2 自分のアクセストークンを取得したい場合
- p 自分自身のアクセストークンは、設定 > API で確認できます。
- p.tip
- | アカウントを乗っ取られてしまう可能性があるため、トークンは第三者に教えないでください(アプリなどにも入力しないでください)。
- br
- | 万が一トークンが漏れたりその可能性がある場合は トークンを再生成できます。(副作用として、ログインしているすべてのデバイスでログアウトが発生します)
-
- section
- h2 他人のアクセストークンを取得する
- p
- | 不特定多数のユーザーからAPIを利用したい場合、アプリケーションを作成します。
- br
- | アプリケーションを作成すると、ユーザーが連携を許可した時に、そのユーザーのアクセストークンを取得することができます。
- p アプリケーションを作成しアクセストークンを取得するまでの流れを見ていきます。
-
- section
- h3 アプリケーションを作成する
- p まずはあなたのアプリケーションを作成しましょう。
- p
+### アプリケーションを作成する
+まずはあなたのアプリケーションを作成しましょう。
| <a href=#{dev_url} target="_blank">デベロッパーセンター</a>にアクセスし、アプリ > アプリ作成 に進みます。
br
| 次に、フォームに必要事項を記入します:
diff --git a/src/docs/api/library.md b/src/docs/api/library.md
new file mode 100644
index 0000000000..71ddbe345d
--- /dev/null
+++ b/src/docs/api/library.md
@@ -0,0 +1,8 @@
+ライブラリ
+================================================================
+
+Misskey APIを便利に利用するためのライブラリ一覧です。
+
+.NET
+----------------------------------------------------------------
+* **[Misq (公式)](https://github.com/syuilo/Misq)**
diff --git a/src/docs/api/library.pug b/src/docs/api/library.pug
deleted file mode 100644
index 4b2943b2a9..0000000000
--- a/src/docs/api/library.pug
+++ /dev/null
@@ -1,14 +0,0 @@
-extend ../BASE
-
-block title
- | ライブラリ
-
-block content
- h1 ライブラリ
-
- p Misskey APIを便利に利用するためのライブラリ一覧です。
-
- section
- h2 .NET
- ul
- li: strong: a(href='https://github.com/syuilo/Misq') Misq (公式)