Switch to NPM-managed SwaggerUI.

AzuraCast · Nov 28, 2024 · 614d919 · 614d919
1 parent bab5a4f
commit 614d919
Show file tree

Hide file tree

Showing 23 changed files with 1,889 additions and 238 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -56,17 +56,17 @@ USER node
 WORKDIR /data/builtin
 
 RUN rm -rf ./src ./dist ./public \
-    && mkdir -p ./src/content ./src/images ./src/scss \
+    && mkdir -p ./src/content/docs ./src/pages ./src/images ./src/scss \
     && cp ../src/content/config.ts ./src/content \
     && cp -R ../src/content/docs/docs ./src/content/docs \
+    && cp -R ../src/pages/api ./src/pages/api \
     && cp -R ../src/images/* ./src/images \
     && cp -R ../src/scss/* ./src/scss \
     && rm -f ./src/content/docs/*.* \
     && cp ./index.md ./src/content/docs \
-    && mkdir -p ./public \ 
-    && cp -R ../public/api ./public/api \
+    && mkdir -p ./public \
     && cp -R ../public/img ./public/img \
-    && sed -i -r 's|url: "(.*?)"|url: "/api/openapi.yml"|' ./public/api/swagger-initializer.js \
+    && sed -i -r 's|url: "(.*?)"|url: "/api/openapi.yml"|' ./src/pages/api/index.astro \
     && cd .. \
     && npm ci --include=dev \
     && npm run builtin-build \

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -2,7 +2,7 @@ services:
   frontend:
     build:
       context: .
-      target: development
+      target: builtin
     ports:
       - '4321:4321'
     user: 1000:1000

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -14,6 +14,7 @@
     "@astrojs/starlight": "^0.29.2",
     "astro": "^4.16.16",
     "bootstrap": "^5.3",
-    "sass": "^1.77"
+    "sass": "^1.77",
+    "swagger-ui": "^5.18.2"
   }
 }
diff --git a/public/api/favicon-16x16.png b/public/api/favicon-16x16.png
diff --git a/public/api/favicon-32x32.png b/public/api/favicon-32x32.png
diff --git a/public/api/index.css b/public/api/index.css
diff --git a/public/api/index.html b/public/api/index.html
diff --git a/public/api/oauth2-redirect.html b/public/api/oauth2-redirect.html
diff --git a/public/api/swagger-initializer.js b/public/api/swagger-initializer.js
diff --git a/public/api/swagger-ui-bundle.js b/public/api/swagger-ui-bundle.js
diff --git a/public/api/swagger-ui-bundle.js.map b/public/api/swagger-ui-bundle.js.map
diff --git a/public/api/swagger-ui-es-bundle-core.js b/public/api/swagger-ui-es-bundle-core.js
diff --git a/public/api/swagger-ui-es-bundle-core.js.map b/public/api/swagger-ui-es-bundle-core.js.map
diff --git a/public/api/swagger-ui-es-bundle.js b/public/api/swagger-ui-es-bundle.js
diff --git a/public/api/swagger-ui-es-bundle.js.map b/public/api/swagger-ui-es-bundle.js.map
diff --git a/public/api/swagger-ui-standalone-preset.js b/public/api/swagger-ui-standalone-preset.js
diff --git a/public/api/swagger-ui-standalone-preset.js.map b/public/api/swagger-ui-standalone-preset.js.map
diff --git a/public/api/swagger-ui.css b/public/api/swagger-ui.css
diff --git a/public/api/swagger-ui.css.map b/public/api/swagger-ui.css.map
diff --git a/public/api/swagger-ui.js b/public/api/swagger-ui.js
diff --git a/public/api/swagger-ui.js.map b/public/api/swagger-ui.js.map
diff --git a/src/pages/api/index.astro b/src/pages/api/index.astro
@@ -0,0 +1,44 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>Swagger UI</title>
+
+    <style>
+      html {
+        box-sizing: border-box;
+        overflow: -moz-scrollbars-vertical;
+        overflow-y: scroll;
+      }
+
+      *,
+      *:before,
+      *:after {
+        box-sizing: inherit;
+      }
+
+      body {
+        margin: 0;
+        background: #fafafa;
+      }
+    </style>
+  </head>
+
+  <body>
+    <div id="swagger-ui"></div>
+
+    <script>
+      import SwaggerUI from "swagger-ui";
+      import "swagger-ui/dist/swagger-ui.css";
+      import SwaggerUIStandalonePreset from "swagger-ui/dist/swagger-ui-standalone-preset";
+
+      SwaggerUI({
+        url: "https://raw.githubusercontent.com/AzuraCast/AzuraCast/main/web/static/openapi.yml",
+        dom_id: "#swagger-ui",
+        deepLinking: true,
+        presets: [SwaggerUI.presets.apis, SwaggerUIStandalonePreset],
+        layout: "StandaloneLayout",
+      });
+    </script>
+  </body>
+</html>