summaryrefslogtreecommitdiff
path: root/src/docs/api
diff options
context:
space:
mode:
Diffstat (limited to 'src/docs/api')
-rw-r--r--src/docs/api/entities/post.pug149
-rw-r--r--src/docs/api/entities/user.pug122
-rw-r--r--src/docs/api/getting-started.md73
-rw-r--r--src/docs/api/library.md8
4 files changed, 0 insertions, 352 deletions
diff --git a/src/docs/api/entities/post.pug b/src/docs/api/entities/post.pug
deleted file mode 100644
index 954f172717..0000000000
--- a/src/docs/api/entities/post.pug
+++ /dev/null
@@ -1,149 +0,0 @@
-extend ../../BASE
-
-block title
- | Entity: Post
-
-block content
- h1 Post
- p 投稿を表します。
-
- section
- h2 Properties
- table.entity
- thead: tr
- td Name
- td Type
- td Description
- tbody
- tr.nullable.optional
- td app
- td: a(href='./app', target='_blank') App
- td 投稿したアプリ
- tr.nullable
- td app_id
- td ID
- td 投稿したアプリのID
- tr
- td created_at
- td Date
- td 投稿日時
- tr
- td id
- td ID
- td 投稿ID
- tr.optional
- td is_liked
- td Boolean
- td いいね したかどうか
- tr
- td likes_count
- td Number
- td いいね数
- tr.nullable.optional
- td media_ids
- td ID[]
- td 添付されたメディアのIDの配列
- tr.nullable.optional
- td media
- td: a(href='./drive-file', target='_blank') DriveFile[]
- td 添付されたメディアの配列
- tr
- td replies_count
- td Number
- td 返信数
- tr.optional
- td reply
- td: a(href='./post', target='_blank') Post
- td 返信先の投稿
- tr.nullable
- td reply_id
- td ID
- td 返信先の投稿のID
- tr.optional
- td repost
- td: a(href='./post', target='_blank') Post
- td Repostした投稿
- tr
- td repost_count
- td Number
- td Repostされた数
- tr.nullable
- td repost_id
- td ID
- td Repostした投稿のID
- tr.nullable
- td text
- td String
- td 本文
- tr.optional
- td user
- td: a(href='./user', target='_blank') User
- td 投稿者
- tr
- td user_id
- td ID
- td 投稿者のID
-
- section
- h2 Example
- pre: code.
- {
- "created_at": "2016-12-10T00:28:50.114Z",
- "media_ids": null,
- "reply_id": "584a16b15860fc52320137e3",
- "repost_id": null,
- "text": "小日向美穂だぞ！",
- "user_id": "5848bf7764e572683f4402f8",
- "app_id": null,
- "likes_count": 1,
- "replies_count": 1,
- "id": "584b4c42d8e5186f8f755d0c",
- "user": {
- "birthday": null,
- "created_at": "2016-12-08T02:03:35.332Z",
- "bio": "女が嫌いです、女性は好きです",
- "followers_count": 11,
- "following_count": 11,
- "links": null,
- "location": "",
- "name": "女が嫌い",
- "posts_count": 26,
- "likes_count": 2,
- "liked_count": 20,
- "username": "onnnagakirai",
- "id": "5848bf7764e572683f4402f8",
- "avatar_url": "https://file.himasaku.net/5848c0ec64e572683f4402fc",
- "banner_url": "https://file.himasaku.net/5848c12864e572683f4402fd",
- "is_following": true,
- "is_followed": true
- },
- "reply": {
- "created_at": "2016-12-09T02:28:01.563Z",
- "media_ids": null,
- "reply_id": "5849d35e547e4249be329884",
- "repost_id": null,
- "text": "アイコン小日向美穂？",
- "user_id": "57d01a501fdf2d07be417afe",
- "app_id": null,
- "replies_count": 1,
- "id": "584a16b15860fc52320137e3",
- "user": {
- "birthday": null,
- "created_at": "2016-09-07T13:46:56.605Z",
- "bio": "どうすれば君だけのために生きていけるの",
- "followers_count": 51,
- "following_count": 97,
- "links": null,
- "location": "川崎",
- "name": "きな子",
- "posts_count": 4813,
- "username": "syuilo",
- "likes_count": 3141,
- "liked_count": 750,
- "id": "57d01a501fdf2d07be417afe",
- "avatar_url": "https://file.himasaku.net/583ddc6e64df272771f74c1a",
- "banner_url": "https://file.himasaku.net/584bfc82d8e5186f8f755ec5"
- }
- },
- "is_liked": true
- }
diff --git a/src/docs/api/entities/user.pug b/src/docs/api/entities/user.pug
deleted file mode 100644
index a37886bb19..0000000000
--- a/src/docs/api/entities/user.pug
+++ /dev/null
@@ -1,122 +0,0 @@
-extend ../../BASE
-
-block title
- | Entity: User
-
-block content
- h1 User
- p ユーザーを表します。
-
- section
- h2 Properties
- table.entity
- thead: tr
- td Name
- td Type
- td Description
- tbody
- tr.nullable.optional
- td avatar_id
- td ID
- td アバターに設定しているドライブのファイルのID
- tr.nullable
- td avatar_url
- td String
- td アバターURL
- tr.nullable.optional
- td banner_id
- td ID
- td バナーに設定しているドライブのファイルのID
- tr.nullable
- td banner_url
- td String
- td バナーURL
- tr.nullable
- td bio
- td String
- td プロフィール
- tr.nullable
- td birthday
- td String
- td 誕生日(YYYY-MM-DD)
- tr
- td created_at
- td Date
- td アカウント作成日時
- tr.optional
- td drive_capacity
- td Number
- td ドライブの最大容量(byte単位)
- tr
- td followers_count
- td Number
- td フォロワー数
- tr
- td following_count
- td Number
- td フォロー数
- tr
- td id
- td ID
- td ユーザーID
- tr.optional
- td is_bot
- td Boolean
- td botかどうか
- tr.optional
- td is_followed
- td Boolean
- td フォローされているか
- tr.optional
- td is_following
- td Boolean
- td フォローしているか
- tr
- td liked_count
- td Number
- td 投稿にいいねされた数
- tr
- td likes_count
- td Number
- td 投稿にいいねした数
- tr.nullable
- td location
- td String
- td 住処
- tr
- td name
- td String
- td ニックネーム
- tr
- td posts_count
- td Number
- td 投稿数
- tr
- td username
- td String
- td ユーザー名
-
- section
- h2 Example
- pre: code.
- {
- "avatar_id": "583ddc6e64df272771f74c1a",
- "avatar_url": "https://file.himasaku.net/583ddc6e64df272771f74c1a",
- "banner_id": "584bfc82d8e5186f8f755ec5",
- "banner_url": "https://file.himasaku.net/584bfc82d8e5186f8f755ec5",
- "bio": "どうすれば君だけのために生きていけるの",
- "birthday": "1997-12-06",
- "created_at": "2016-09-07T13:46:56.605Z",
- "drive_capacity": 1073741824,
- "email": null,
- "followers_count": 51,
- "following_count": 97,
- "id": "57d01a501fdf2d07be417afe",
- "liked_count": 750,
- "likes_count": 3130,
- "links": null,
- "location": "川崎",
- "name": "きな子",
- "posts_count": 4811,
- "username": "syuilo"
- }
diff --git a/src/docs/api/getting-started.md b/src/docs/api/getting-started.md
deleted file mode 100644
index e13659914e..0000000000
--- a/src/docs/api/getting-started.md
+++ /dev/null
@@ -1,73 +0,0 @@
-Getting Started
-================================================================
-MisskeyはREST APIやStreaming APIを提供しており、プログラムからMisskeyの全ての機能を利用することができます。
-それらのAPIを利用するには、まずAPIを利用したいアカウントのアクセストークンを取得する必要があります:
-
-自分のアクセストークンを取得したい場合
-----------------------------------------------------------------
-自分自身のアクセストークンは、設定 > API で確認できます。
-<p class="tip">
- アカウントを乗っ取られてしまう可能性があるため、トークンは第三者に教えないでください(アプリなどにも入力しないでください)。<br>
- 万が一トークンが漏れたりその可能性がある場合は トークンを再生成できます。(副作用として、ログインしているすべてのデバイスでログアウトが発生します)
-</p>
-
-他人のアクセストークンを取得する
-----------------------------------------------------------------
-不特定多数のユーザーからAPIを利用したい場合、アプリケーションを作成します。
-アプリケーションを作成すると、ユーザーが連携を許可した時に、そのユーザーのアクセストークンを取得することができます。
-
-アプリケーションを作成してアクセストークンを取得するまでの流れを説明します。
-
-### アプリケーションを作成する
-まずはあなたのアプリケーションを作成しましょう。
- | <a href=#{dev_url} target="_blank">デベロッパーセンター</a>にアクセスし、アプリ > アプリ作成 に進みます。
- br
- | 次に、フォームに必要事項を記入します:
- dl
- dt アプリケーション名
- dd あなたのアプリケーションの名前。
- dt Named ID
- dd アプリを識別する/a-z-/で構成されたID。
- dt アプリの概要
- dd アプリの簡単な説明を入力してください。
- dt コールバックURL
- dd あなたのアプリケーションがWebアプリケーションである場合、ユーザーが後述するフォームで認証を終えた際にリダイレクトするURLを設定できます。
- dt 権限
- dd アプリケーションが要求する権限。ここで要求した機能だけがAPIからアクセスできます。
- p.tip
- | 権限はアプリ作成後も変更できますが、新たな権限を付与する場合、その時点で関連付けられているユーザーはすべて無効になります。
- p
- | アプリケーションを作成すると、作ったアプリの管理ページに進みます。
- br
- | アプリのシークレットキー(App Secret)が表示されていますので、メモしておいてください。
- p.tip
- | アプリに成りすまされる可能性があるため、極力このシークレットキーは公開しないようにしてください。
-
- section
- h3 ユーザーに認証させる
- p あなたのアプリを使ってもらうには、ユーザーにアカウントへアクセスすることを許可してもらい、Misskeyにそのユーザーのアクセストークンを発行してもらう必要があります。
- p 認証セッションを開始するには、<code>#{api_url}/auth/session/generate</code>へパラメータに<code>app_secret</code>としてApp Secretを含めたリクエストを送信します。
- p
- | そうすると、レスポンスとして認証セッションのトークンや認証フォームのURLが取得できます。
- br
- | この認証フォームのURLをブラウザで表示し、ユーザーにフォームを表示してください。
- section
- h4 あなたのアプリがコールバックURLを設定している場合
- p ユーザーがアプリの連携を許可すると設定しているコールバックURLに<code>token</code>という名前でセッションのトークンが含まれたクエリを付けてリダイレクトします。
- section
- h4 あなたのアプリがコールバックURLを設定していない場合
- p ユーザーがアプリの連携を許可したことを(何らかの方法で(たとえばボタンを押させるなど))確認出来るようにしてください。
- p
- | 次に、<code>#{api_url}/auth/session/userkey</code>へ<code>app_secret</code>としてApp Secretを、<code>token</code>としてセッションのトークンをパラメータとして付与したリクエストを送信してください。
- br
- | 上手くいけば、認証したユーザーのアクセストークンがレスポンスとして取得できます。おめでとうございます！
- p
- | 以降アクセストークンは、<strong>ユーザーのアクセストークン+アプリのシークレットキーをsha256したもの</strong>として扱います。
-
- p アクセストークンを取得できたら、あとは簡単です。REST APIなら、リクエストにアクセストークンを<code>i</code>としてパラメータに含めるだけです。
-
- section
- h2 リクエスト形式
- p <code>application/json</code>を受け付けます。
- p.tip
- | 現在<code>application/x-www-form-urlencoded</code>も受け付けていますが、将来的にこのサポートはされなくなる予定です。
diff --git a/src/docs/api/library.md b/src/docs/api/library.md
deleted file mode 100644
index 71ddbe345d..0000000000
--- a/src/docs/api/library.md
+++ /dev/null
@@ -1,8 +0,0 @@
-ライブラリ
-================================================================
-
-Misskey APIを便利に利用するためのライブラリ一覧です。
-
-.NET
-----------------------------------------------------------------
-* **[Misq (公式)](https://github.com/syuilo/Misq)**
generated by cgit v1.2.3-freya (git 2.53.0.84.g453e7b744a) at 2026-03-03 19:11:17 +0000