Add utility to set up Swagger

packages/nestjs-shared/src/index.ts

@@ -1,2 +1,3 @@
 export * from './lib/decorator'
 export * from './lib/dto'
+export * from './lib/util'

packages/nestjs-shared/src/lib/util/index.ts

@@ -0,0 +1 @@
+export * from './with-swagger.util'

packages/nestjs-shared/src/lib/util/with-swagger.util.ts

@@ -0,0 +1,29 @@
+import { INestApplication } from '@nestjs/common'
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger'
+import { patchNestJsSwagger } from 'nestjs-zod'
+
+/**
+ * Adds Swagger documentation to the application.
+ *
+ * @param app - The INestApplication instance.
+ * @returns The modified INestApplication instance.
+ */
+export const withSwagger =
+  (params: { title: string; description: string; version: string }) =>
+  (app: INestApplication): INestApplication => {
+    // IMPORTANT: This modifies the Nest Swagger module to be compatible with
+    // DTOs created by Zod schemas. The patch MUST be done before the
+    // configuration process.
+    patchNestJsSwagger()
+
+    const document = SwaggerModule.createDocument(
+      app,
+      new DocumentBuilder().setTitle(params.title).setDescription(params.description).setVersion(params.version).build()
+    )
+
+    SwaggerModule.setup('docs', app, document, {
+      customSiteTitle: `${params.title} API`
+    })
+
+    return app
+  }