Swagger 설정에 Basic Auth 추가 및 활성화 환경변수 지원

Author: sscoderati

.env.example

@@ -1,2 +1,7 @@
 DATABASE_URL=postgres://marrylife:marrylife@db:5432/marrylife_db
 PORT=4000
+
+# Swagger 설정
+SWAGGER_ENABLED=true
+SWAGGER_USER=admin
+SWAGGER_PASSWORD=adminpw

apps/api/package.json

@@ -34,6 +34,7 @@
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.4",
     "cookie-parser": "^1.4.7",
+    "express-basic-auth": "^1.2.1",
     "reflect-metadata": "^0.2.2",
     "rxjs": "^7.8.1",
     "swagger-ui-express": "^5.0.1"

apps/api/src/main.ts

@@ -3,6 +3,7 @@ import { NestFactory } from '@nestjs/core';
 import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
 import { runMigrations } from '@marrylife/db';
 import cookieParser from 'cookie-parser';
+import basicAuth from 'express-basic-auth';
 import { AppModule } from './app.module';
 import { HttpExceptionFilter } from './common/filters/http-exception.filter';
 import { ResponseInterceptor } from './common/interceptors/response.interceptor';
@@ -31,16 +32,32 @@ async function bootstrap() {
   app.useGlobalInterceptors(new ResponseInterceptor());
   app.useGlobalFilters(new HttpExceptionFilter());
 
-  const swaggerConfig = new DocumentBuilder()
-    .setTitle('MarryLife API')
-    .setDescription('MarryLife API 문서')
-    .setVersion('1.0.0')
-    .addBearerAuth()
-    .build();
-  const swaggerDocument = SwaggerModule.createDocument(app, swaggerConfig);
-  SwaggerModule.setup('docs', app, swaggerDocument, {
-    useGlobalPrefix: true,
-  });
+  const swaggerEnabled = process.env.SWAGGER_ENABLED !== 'false';
+  if (swaggerEnabled) {
+    const swaggerUser = process.env.SWAGGER_USER;
+    const swaggerPassword = process.env.SWAGGER_PASSWORD;
+    if (swaggerUser && swaggerPassword) {
+      app.use(
+        '/api/docs',
+        basicAuth({
+          users: { [swaggerUser]: swaggerPassword },
+          challenge: true,
+          realm: 'MarryLife API Docs',
+        }),
+      );
+    }
+
+    const swaggerConfig = new DocumentBuilder()
+      .setTitle('MarryLife API')
+      .setDescription('MarryLife API 문서')
+      .setVersion('1.0.0')
+      .addBearerAuth()
+      .build();
+    const swaggerDocument = SwaggerModule.createDocument(app, swaggerConfig);
+    SwaggerModule.setup('docs', app, swaggerDocument, {
+      useGlobalPrefix: true,
+    });
+  }
 
   const port = process.env.PORT ?? 4000;
   await app.listen(port);