feat: Option to choose between swagger-ui and scalar for API docs

config/default.js

@@ -25,8 +25,10 @@ module.exports = {
 	apiDocs: {
 		enabled: true,
 		path: '/api-docs',
-		uiOptions: {
-			filter: true
+		ui: 'swagger-ui',
+		config: {
+			filter: true,
+			hideClientButton: true
 		}
 	},
 

package.json

@@ -59,6 +59,7 @@
     "@fastify/swagger": "^9.2.0",
     "@fastify/swagger-ui": "^5.1.0",
     "@fastify/type-provider-typebox": "^5.0.1",
+    "@scalar/fastify-api-reference": "^1.25.78",
     "@sinclair/typebox": "^0.33.22",
     "agenda": "^4.3.0",
     "config": "^3.3.11",

src/app/core/user/eua/eua.controller.ts

@@ -104,7 +104,7 @@ export default function (_fastify: FastifyInstance) {
 		url: '/eua/:id',
 		schema: {
 			description: 'Update EUA details',
-			tags: ['Eua'],
+			tags: ['EUA'],
 			params: IdParamsType
 		},
 		preValidation: requireAdminAccess,

src/lib/fastify.ts

@@ -9,6 +9,7 @@ import { Authenticator } from '@fastify/passport';
 import fastifySession from '@fastify/session';
 import fastifySwagger from '@fastify/swagger';
 import fastifySwaggerUi from '@fastify/swagger-ui';
+import scalarApiReference from '@scalar/fastify-api-reference';
 import config from 'config';
 import MongoStore from 'connect-mongo';
 import { fastify, FastifyInstance } from 'fastify';
@@ -54,7 +55,7 @@ export async function init(db: Mongoose) {
 		});
 	}
 
-	initSwaggerAPI(app);
+	await initAPIDocs(app);
 
 	initActuator(app);
 
@@ -118,7 +119,7 @@ async function initModulesServerRoutes(app: FastifyInstance) {
 	);
 }
 
-function initSwaggerAPI(app: FastifyInstance) {
+async function initAPIDocs(app: FastifyInstance) {
 	// apiDocs must be enabled explicitly in the config
 	if (config.get<boolean>('apiDocs.enabled') !== true) {
 		return;
@@ -139,10 +140,18 @@ function initSwaggerAPI(app: FastifyInstance) {
 			}
 		}
 	});
-	app.register(fastifySwaggerUi, {
-		routePrefix: config.get<string>('apiDocs.path'),
-		uiConfig: config.get<Record<string, unknown>>('apiDocs.uiOptions')
-	});
+
+	if (config.get<string>('apiDocs.ui') === 'scalar') {
+		await app.register(scalarApiReference, {
+			routePrefix: config.get<`/${string}`>('apiDocs.path'),
+			configuration: config.get<Record<string, unknown>>('apiDocs.config')
+		});
+	} else {
+		app.register(fastifySwaggerUi, {
+			routePrefix: config.get<string>('apiDocs.path'),
+			uiConfig: config.get<Record<string, unknown>>('apiDocs.config')
+		});
+	}
 }
 
 function initActuator(app: FastifyInstance) {