Introduce OpenAPI specs (misskey-dev#4351)

* wip * wip * wip * Update index.ts * Update gen-openapi-spec.ts * Update api.ja-JP.md * Fix * Improve doc * Update gen-openapi-spec.ts * Update redoc.html * Improve doc * Update gen-openapi-spec.ts * Improve doc * Update CHANGELOG.md
6wFh3kVo · Feb 23, 2019 · 52774bb · 52774bb
1 parent 68a6758
commit 52774bb
Show file tree

Hide file tree

Showing 173 changed files with 1,091 additions and 876 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@ ChangeLog
 
 unreleasded
 ----------
+* APIドキュメント刷新
 * /api/v1/instance/peers 復活
 * 「返信が遷移後も残り続ける問題を修正」([9beddc9](https://github.com/syuilo/misskey/commit/9beddc941a716f1322ae0b7d71d159edd642a399)) によって遷移前に返信が表示されなくなった問題を修正
 * デッキモードにてユーザーのプロフィールを連続で見たとき、アクティビティや画像が前のユーザーのもののまま表示される問題を修正

diff --git a/assets/api-doc.png b/assets/api-doc.png
diff --git a/package.json b/package.json
@@ -102,7 +102,7 @@
 		"bcryptjs": "2.4.3",
 		"bee-queue": "1.2.2",
 		"bootstrap-vue": "2.0.0-rc.11",
-		"cafy": "14.0.1",
+		"cafy": "15.1.0",
 		"chai": "4.2.0",
 		"chai-http": "4.2.1",
 		"chalk": "2.4.2",

diff --git a/src/client/assets/redoc.html b/src/client/assets/redoc.html
@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+	<head>
+		<title>Misskey API</title>
+		<!-- needed for adaptive design -->
+		<meta charset="utf-8"/>
+		<meta name="viewport" content="width=device-width, initial-scale=1">
+		<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
+
+		<!--
+		ReDoc doesn't change outer page styles
+		-->
+		<style>
+			body {
+				margin: 0;
+				padding: 0;
+			}
+		</style>
+	</head>
+	<body>
+		<redoc spec-url='/api.json'></redoc>
+		<script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script>
+	</body>
+</html>
diff --git a/src/docs/api.ja-JP.md b/src/docs/api.ja-JP.md
@@ -74,7 +74,7 @@ APIはすべてリクエストのパラメータ・レスポンスともにJSON
 
 ストリーミングAPIも提供しています。
 
-APIリファレンスもご確認ください。
+[APIリファレンス](/api-doc)もご確認ください。
 
 ### レートリミット
 Misskey APIにはレートリミットがあり、短時間のうちに多数のリクエストを送信すると、一定時間APIを利用することができなくなることがあります。
diff --git a/src/docs/api/endpoints/style.styl b/src/docs/api/endpoints/style.styl
diff --git a/src/docs/api/endpoints/view.pug b/src/docs/api/endpoints/view.pug
diff --git a/src/docs/api/entities/drive-file.yaml b/src/docs/api/entities/drive-file.yaml
diff --git a/src/docs/api/entities/drive-folder.yaml b/src/docs/api/entities/drive-folder.yaml