update: swagger doc

package-lock.json

@@ -929,6 +929,29 @@
         "node": ">= 0.8"
       }
     },
+    "node_modules/encoding": {
+      "version": "0.1.13",
+      "resolved": "https://registry.npmjs.org/encoding/-/encoding-0.1.13.tgz",
+      "integrity": "sha512-ETBauow1T35Y/WZMkio9jiM0Z5xjHHmJ4XmjZOq1l/dXz3lr2sRn87nJy20RupqSh1F2m3HHPSp8ShIPQJrJ3A==",
+      "optional": true,
+      "peer": true,
+      "dependencies": {
+        "iconv-lite": "^0.6.2"
+      }
+    },
+    "node_modules/encoding/node_modules/iconv-lite": {
+      "version": "0.6.3",
+      "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz",
+      "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==",
+      "optional": true,
+      "peer": true,
+      "dependencies": {
+        "safer-buffer": ">= 2.1.2 < 3.0.0"
+      },
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
     "node_modules/escape-html": {
       "version": "1.0.3",
       "resolved": "https://registry.npmjs.org/escape-html/-/escape-html-1.0.3.tgz",

src/lib/swagger/swagger.ts

@@ -178,10 +178,9 @@ class SwaggerRegistry {
     const document = {
       openapi: "3.0.0",
       info: {
-        title: "Express TypeScript Swagger",
+        title: "Modarb API Documentation",
         version: "1.0.0",
-        description:
-          "API documentation using Swagger and Express with TypeScript.",
+        description: "Look! Docs!",
       },
       servers: [
         {
@@ -205,6 +204,7 @@ class SwaggerRegistry {
       },
     };
 
+    console.log(JSON.stringify(document, null, 2));
     return document;
   }
 }

src/routes.ts

@@ -49,7 +49,24 @@ const setCustomRoutes = async (router: Router) => {
   router.use(
     "/docs",
     swaggerUi.serve,
-    swaggerUi.setup(swaggerRegistry.generateSwaggerDocument())
+    swaggerUi.setup(swaggerRegistry.generateSwaggerDocument(), {
+      customCss: ".swagger-ui .topbar { display: none }",
+      customSiteTitle: "API Documentation",
+      swaggerOptions: {
+        layout: "StandaloneLayout",
+        deepLinking: true,
+        docExpansion: "none",
+        filter: true,
+        tagsSorter: "alpha",
+        operationsSorter: "alpha",
+        showMutatedRequest: true,
+        showMutatedResponse: true,
+        showRequestDuration: true,
+        persistAuthorization: true,
+        displayRequestDuration: true,
+        withCredentials: true,
+      },
+    })
   );
 
   // Invalid URL handler