server: documentation part 1

2026-04-29 00:59:58 -07:00 · 2025-10-06 22:53:50 +02:00
parent db344749b6
commit 7ff79c3164
23 changed files with 670 additions and 183 deletions
--- a/crates/brk_server/src/api/scalar.html
+++ b/crates/brk_server/src/api/scalar.html
@@ -0,0 +1,26 @@
+<!doctype html>
+<html>
+  <head>
+    <title>Scalar API Reference</title>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+  </head>
+
+  <body>
+    <div id="app"></div>
+
+    <!-- https://app.unpkg.com/@scalar/api-reference@1.37.0/files/dist/browser/standalone.js -->
+    <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
+
+    <script>
+      Scalar.createApiReference("#app", {
+        url: "/api.json",
+        metaData: {
+          title: "BRK API",
+          description: "Bitcoin Research Kit's API documentation via Scalar",
+          hideClientButton: true,
+        },
+      });
+    </script>
+  </body>
+</html>