Merge pull request #4 from xch-dev/openapi-uri

OpenAPI

Author: Rigidity

.github/workflows/deploy.yml

@@ -32,9 +32,12 @@ jobs:
       - name: Install dependencies
         run: pnpm install
 
+      - name: Build OpenAPI
+        run: pnpm docusaurus gen-api-docs all
+
       - name: Build
         run: pnpm build
-
+        
       - name: Setup GitHub Pages
         uses: actions/configure-pages@v5
 

.gitignore

@@ -7,6 +7,7 @@
 # Generated files
 .docusaurus
 .cache-loader
+/docs/rpc
 
 # Misc
 .DS_Store

docs/rpc/setup.md docs/rpc-setup.mddocs/rpc/setup.md renamed to docs/rpc-setup.md

@@ -1,6 +1,6 @@
 ---
 title: Setup
-slug: /rpc-setup
+slug: /rpc/setup
 ---
 
 # RPC Setup

docs/rpc/offers.md

@@ -1,5 +1,6 @@
 import type * as Preset from "@docusaurus/preset-classic";
 import type { Config } from "@docusaurus/types";
+import type * as OpenApiPlugin from "docusaurus-plugin-openapi-docs";
 import { themes as prismThemes } from "prism-react-renderer";
 
 const config: Config = {
@@ -23,13 +24,33 @@ const config: Config = {
         docs: {
           sidebarPath: "./sidebars.ts",
           routeBasePath: "",
+          docItemComponent: "@theme/ApiItem",
         },
         theme: {
           customCss: "./src/css/custom.css",
         },
       } satisfies Preset.Options,
     ],
   ],
+  plugins: [
+    [
+      "docusaurus-plugin-openapi-docs",
+      {
+        id: "api",
+        docsPluginId: "classic",
+        config: {
+          sage_rpc: {
+            specPath: "src/openapi.json",
+            outputDir: "docs/rpc/",
+            sidebarOptions: {
+              groupPathsBy: "tag",
+            },
+          } satisfies OpenApiPlugin.Options,
+        },
+      },
+    ],
+  ],
+  themes: ["docusaurus-theme-openapi-docs"],
   themeConfig: {
     navbar: {
       title: "xch.dev",

docs/rpc/types.md

@@ -20,6 +20,8 @@
     "@docusaurus/preset-classic": "3.7.0",
     "@mdx-js/react": "^3.0.0",
     "clsx": "^2.0.0",
+    "docusaurus-plugin-openapi-docs": "^4.5.1",
+    "docusaurus-theme-openapi-docs": "^4.5.1",
     "prism-react-renderer": "^2.3.0",
     "react": "^19.0.0",
     "react-dom": "^19.0.0"