Merge pull request #7 from pulsate-dev/add-api-reference

feat: Add API Reference

components/ScalarAPIReference.tsx

@@ -0,0 +1,30 @@
+import { ApiReferenceReact } from '@scalar/api-reference-react';
+import '@scalar/api-reference-react/style.css';
+
+/**
+ * This is a React component that renders the Pulsate API reference.
+ * It uses the `ApiReferenceReact` component from the `@scalar/api-reference-react` package.
+ *
+ * Nextra cannot properly read TSX files configured as pages, so what should be used as pages are component and imported into MDX.
+ * A warning message by autoprefixer is displayed, but since it is not an error, it is ignored here.
+ *
+ * @return The API reference component.
+ */
+export default function ScalarAPIReference() {
+  // https://github.com/scalar/scalar/blob/main/documentation/configuration.md
+  return (
+    <ApiReferenceReact
+      configuration={{
+        isEditable: false,
+        darkMode: true,
+        hideDarkModeToggle: true,
+        searchHotKey: 's',
+        theme: 'bluePlanet',
+        // TODO: Support testing the API reference with a staring server
+        spec: {
+          url: 'https://raw.githubusercontent.com/pulsate-dev/pulsate/main/resources/schema.json',
+        },
+      }}
+    />
+  );
+}

package.json

@@ -17,6 +17,8 @@
 		"postinstall": "lefthook install"
 	},
 	"dependencies": {
+		"@scalar/api-reference-react": "^0.3.79",
+		"@scalar/nextjs-api-reference": "^0.4.79",
 		"next": "^14.2.5",
 		"nextra": "^2.13.4",
 		"nextra-theme-docs": "^2.13.4",

pages/_meta.en.json

@@ -20,5 +20,13 @@
     "title": "Roadmap",
     "type": "page",
     "display": "hidden"
+  },
+  "api": {
+    "title": "API Reference",
+    "type": "page",
+    "display": "hidden",
+    "theme": {
+      "layout": "raw"
+    }
   }
 }

pages/_meta.ja.json

@@ -20,5 +20,23 @@
     "title": "ロードマップ",
     "type": "page",
     "display": "hidden"
+  },
+  "api": {
+    "title": "API リファレンス",
+    "type": "page",
+    "display": "hidden",
+    "theme": {
+      "layout": "raw"
+    }
+  },
+  "other": {
+    "title": "その他",
+    "type": "menu",
+    "items": {
+      "api-reference": {
+        "title": "Pulsate API Document",
+        "href": "/api"
+      }
+    }
   }
 }

pages/api.ja.mdx

@@ -0,0 +1,3 @@
+import ScalarAPIReference from "../components/ScalarAPIReference";
+
+<ScalarAPIReference />