add api page

YABCounts · Nov 19, 2023 · b574a9c · b574a9c
1 parent d17b677
commit b574a9c
Show file tree

Hide file tree

Showing 5 changed files with 1,436 additions and 11 deletions.
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -34,8 +34,8 @@ const config = {
 
   presets: [
     [
-      "classic",
-      /** @type {import('@docusaurus/preset-classic').Options} */
+      "docusaurus-preset-openapi",
+      /** @type {import('docusaurus-preset-openapi').Options} */
       ({
         docs: {
           sidebarPath: require.resolve("./sidebars.js"),
@@ -45,6 +45,10 @@ const config = {
         theme: {
           customCss: require.resolve("./src/css/custom.css"),
         },
+        api: {
+          path: "spec.yaml",
+          routeBasePath: "/api",
+        },
       }),
     ],
   ],
@@ -83,6 +87,11 @@ const config = {
             position: "right",
             label: "Tutorial",
           },
+          {
+            to: "/api",
+            label: "API",
+            position: "right",
+          },
         ],
       },
       footer: {
@@ -95,6 +104,10 @@ const config = {
                 label: "Tutorial",
                 to: "/",
               },
+              {
+                label: "API",
+                to: "/api",
+              },
             ],
           },
           {

diff --git a/package.json b/package.json
@@ -19,9 +19,11 @@
     "@easyops-cn/docusaurus-search-local": "^0.36.0",
     "@mdx-js/react": "^1.6.22",
     "clsx": "^1.2.1",
+    "docusaurus-preset-openapi": "^0.6.4",
     "prism-react-renderer": "^1.3.5",
     "react": "^17.0.2",
-    "react-dom": "^17.0.2"
+    "react-dom": "^17.0.2",
+    "url-loader": "^4.1.1"
   },
   "devDependencies": {
     "@docusaurus/module-type-aliases": "2.4.3",