Startsida Utforska Hjälp
Logga in
fszontagh
/
smartbotic-vectorapi
1
0
Fork 0
Filer Ärenden 0 Pull-förfrågningar 0 Wiki
Bläddra i källkod

feat(docs): serve offline rendered API docs at /docs + web UI link

Vendor RapiDoc 9.3.8 (863 kB, single-file) into api/docs/; serve it publicly
at /docs via a static mount + explicit GET handler in meta.cpp; ship docs
assets in the server .deb; add "API Docs" sidebar link in the web UI.
Fszontagh 1 månad sedan
förälder
c47c590536
incheckning
26af36abad
6 ändrade filer med 34 tillägg och 0 borttagningar
Unifierad Vy Visa Diff Statistik
  1. 9 0
      api/docs/index.html
  2. 1 0
      api/docs/rapidoc-min.js
  3. 2 0
      packaging/deb/create-debs.sh
  4. 10 0
      src/handlers/meta.cpp
  5. 1 0
      src/server.cpp
  6. 11 0
      webui/src/components/AppShell.tsx

+ 9 - 0
api/docs/index.html
Visa fil 

@@ -0,0 +1,9 @@
 
+<!doctype html>
 
+<html lang="en"><head><meta charset="utf-8"><title>smartbotic-vectorapi API</title>
 
+<meta name="viewport" content="width=device-width,initial-scale=1"></head>
 
+<body style="margin:0">
 
+  <rapi-doc spec-url="/openapi.json" theme="dark" bg-color="#0b0f17" text-color="#e5e7eb"
 
+            render-style="read" show-header="false" allow-try="true"
 
+            regular-font="system-ui, sans-serif"></rapi-doc>
 
+  <script type="module" src="/docs/rapidoc-min.js"></script>
 
+</body></html>

Filskillnaden har hållts tillbaka eftersom den är för stor
+ 1 - 0
api/docs/rapidoc-min.js


+ 2 - 0
packaging/deb/create-debs.sh
Visa fil 

@@ -58,6 +58,8 @@ chmod 0755 "$PKG1/usr/bin/smartbotic-vectorapi"
 
 cp "$CONFIG_DIR/config.json" "$PKG1/etc/smartbotic-vectorapi/config.json"
 
 cp "$CONFIG_DIR/config.json" "$PKG1/etc/smartbotic-vectorapi/config.json"
 
 cp "$SYSTEMD_DIR/smartbotic-vectorapi.service" "$PKG1/lib/systemd/system/"
 
 cp "$SYSTEMD_DIR/smartbotic-vectorapi.service" "$PKG1/lib/systemd/system/"
 
 cp "$API_DIR/openapi.json" "$API_DIR/llms.txt" "$PKG1/usr/share/smartbotic-vectorapi/"
 
 cp "$API_DIR/openapi.json" "$API_DIR/llms.txt" "$PKG1/usr/share/smartbotic-vectorapi/"
 
+mkdir -p "$PKG1/usr/share/smartbotic-vectorapi/docs"
 
+cp -a "$API_DIR/docs/." "$PKG1/usr/share/smartbotic-vectorapi/docs/"
 
 cp "$TEMPLATE_DIR/control.server" "$PKG1/DEBIAN/control"
 
 cp "$TEMPLATE_DIR/control.server" "$PKG1/DEBIAN/control"
 
 cp "$SCRIPTS_DIR/server.postinst" "$PKG1/DEBIAN/postinst"
 
 cp "$SCRIPTS_DIR/server.postinst" "$PKG1/DEBIAN/postinst"
 
 cp "$SCRIPTS_DIR/server.prerm"    "$PKG1/DEBIAN/prerm"
 
 cp "$SCRIPTS_DIR/server.prerm"    "$PKG1/DEBIAN/prerm"

+ 10 - 0
src/handlers/meta.cpp
Visa fil 

@@ -36,6 +36,16 @@ void registerMetaRoutes(ApiServer& s) {
 
         res.set_content(ss.str(), "text/plain");
 
         res.set_content(ss.str(), "text/plain");
 
         res.status = 200;
 
         res.status = 200;
 
     });
 
     });
 
+
 
+    // Serve /docs (no trailing slash) -> docs/index.html so the page loads without a redirect.
 
+    svr.Get("/docs", [share](const httplib::Request&, httplib::Response& res) {
 
+        if (share.empty()) { sendJson(res, 404, {{"error", "not configured"}}); return; }
 
+        std::ifstream f(share + "/docs/index.html");
 
+        if (!f) { sendJson(res, 404, {{"error", "not found"}}); return; }
 
+        std::ostringstream ss; ss << f.rdbuf();
 
+        res.set_content(ss.str(), "text/html");
 
+        res.status = 200;
 
+    });
 
 }
 
 }
 
 
 
 } // namespace svapi
 
 } // namespace svapi

+ 1 - 0
src/server.cpp
Visa fil 

@@ -74,6 +74,7 @@ void ApiServer::registerRoutes() {
 
     registerStatsRoutes(*this);
 
     registerStatsRoutes(*this);
 
     registerSettingsRoutes(*this);
 
     registerSettingsRoutes(*this);
 
 
 
+    if (!d_.shareDir.empty()) svr_.set_mount_point("/docs", d_.shareDir + "/docs");
 
     if (!d_.webuiDir.empty()) svr_.set_mount_point("/", d_.webuiDir);
 
     if (!d_.webuiDir.empty()) svr_.set_mount_point("/", d_.webuiDir);
 
 }
 
 }

+ 11 - 0
webui/src/components/AppShell.tsx
Visa fil 

@@ -8,6 +8,7 @@ import {
 
   FolderKanban,
 
   FolderKanban,
 
   KeyRound,
 
   KeyRound,
 
   LogOut,
 
   LogOut,
 
+  BookOpen,
 
 } from 'lucide-react'
 
 } from 'lucide-react'
 
 import { useAuthStore } from '@/stores/authStore'
 
 import { useAuthStore } from '@/stores/authStore'
 
 import { ProjectSelector } from './ProjectSelector'
 
 import { ProjectSelector } from './ProjectSelector'
 
@@ -78,6 +79,16 @@ export function AppShell() {
 
             <SidebarLink key={item.to} item={item} />
 
             <SidebarLink key={item.to} item={item} />
 
           ))}
 
           ))}
 
 
 
+          <a
 
+            href="/docs"
 
+            target="_blank"
 
+            rel="noreferrer"
 
+            className="flex items-center gap-3 px-3 py-2 rounded-md text-sm font-medium transition text-slate-400 hover:text-slate-200 hover:bg-slate-700/50"
 
+          >
 
+            <BookOpen size={18} />
 
+            API Docs
 
+          </a>
 
+
 
           {admin && (
 
           {admin && (
 
             <>
 
             <>
 
               <div className="mt-4 mb-1 px-3">
 
               <div className="mt-4 mb-1 px-3">

Vissa filer visades inte eftersom för många filer har ändrats