Merge pull request #18 from techvariable/enhancement/swagger-optional

Made Swagger configurable based on env variables

Author: abhishekctv

.env.example

@@ -3,6 +3,10 @@ NODE_ENV=#{NODE_ENV}
 LOG_LEVEL=#{LOG_LEVEL}
 PORT=#{PORT}
 
+# Swagger env variables
+SWAGGER_ENABLED=#{SWAGGER_ENABLED}
+SWAGGER_ROUTE=#{SWAGGER_ROUTE}
+
 # Other env vars
 APP_URL=#{APP_URL}
 

src/fastify/fastifyPlugins/swaggerUi.ts

@@ -2,7 +2,10 @@ import fp from 'fastify-plugin'
 import swaggerUI, { type FastifySwaggerUiOptions } from '@fastify/swagger-ui'
 
 export default fp<FastifySwaggerUiOptions>(async (fastify) => {
-  await fastify.register(swaggerUI, {
-    routePrefix: '/docs'
-  })
+  console.log(process.env.SWAGGER_ENABLED === '1', process.env.SWAGGER_ROUTE)
+  if (process.env.SWAGGER_ENABLED === '1') {
+    await fastify.register(swaggerUI, {
+      routePrefix: process.env.SWAGGER_ROUTE
+    })
+  }
 })

src/ts/schemas/env.ts

@@ -36,5 +36,8 @@ export const SEnv = Type.Object({
 
   ADMIN_NAME: Type.String(),
   ADMIN_EMAIL: Type.String(),
-  ADMIN_PASSWORD: Type.String()
+  ADMIN_PASSWORD: Type.String(),
+
+  SWAGGER_ENABLED: Type.String(),
+  SWAGGER_ROUTE: Type.String()
 })