Add Swagger for NDLA endpoints (#2835)

* add swagger * Run php-cs-fixer * fix namespace * document locale format --------- Co-authored-by: emmachughes <[email protected]>
cerpus · Dec 5, 2024 · 5433bf3 · 5433bf3
1 parent 3efb996
commit 5433bf3
Show file tree

Hide file tree

Showing 9 changed files with 2,162 additions and 17 deletions.
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -36,6 +36,8 @@ services:
   hub-vite:
     image: node:18-alpine
     command: [sh, -c, 'npm ci && npm run dev']
+    environment:
+      - SCARF_ANALYTICS=false
     volumes:
       - npm_cache:/root/.npm
       - ./sourcecode/hub:/srv/www/hub

diff --git a/sourcecode/hub/app/Http/Controllers/NdlaLegacy/SwaggerController.php b/sourcecode/hub/app/Http/Controllers/NdlaLegacy/SwaggerController.php
@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Http\Controllers\NdlaLegacy;
+
+use Illuminate\Http\RedirectResponse;
+use Illuminate\Http\Response;
+use Symfony\Component\HttpFoundation\BinaryFileResponse;
+
+use function resource_path;
+
+/**
+ * @deprecated This exists for compatibility with old integrations. New
+ *     integrations with Edlib should not use this.
+ */
+final readonly class SwaggerController
+{
+    public function swagger(): Response
+    {
+        return response()->view('ndla-legacy.swagger');
+    }
+
+    public function redirect(): RedirectResponse
+    {
+        return redirect()->route('ndla-legacy.swagger', status: Response::HTTP_PERMANENTLY_REDIRECT);
+    }
+
+    public function schema(): BinaryFileResponse
+    {
+        return response()->file(resource_path('schema/ndla-openapi.json'), [
+            'Content-Type' => 'application/json',
+        ]);
+    }
+}
diff --git a/sourcecode/hub/package-lock.json b/sourcecode/hub/package-lock.json
diff --git a/sourcecode/hub/package.json b/sourcecode/hub/package.json
@@ -19,7 +19,8 @@
         "bootstrap-icons": "^1.11.3",
         "choices.js": "^11.0.2",
         "date-fns": "^4.1.0",
-        "htmx.org": "^2.0.3"
+        "htmx.org": "^2.0.3",
+        "swagger-ui": "^5.18.2"
     },
     "engines": {
         "node": "^18"

diff --git a/sourcecode/hub/resources/js/swagger.js b/sourcecode/hub/resources/js/swagger.js
@@ -0,0 +1,7 @@
+import SwaggerUI from 'swagger-ui';
+import 'swagger-ui/dist/swagger-ui.css';
+
+SwaggerUI({
+    dom_id: '#swagger',
+    url: document.documentElement.getAttribute('data-openapi-url'),
+});