chore: update swagger setting (#46)

chore/update swagger setting Co-authored-by: shl0501 <[email protected]>
boostcampwm-2024 · Nov 8, 2024 · 4dcfef7 · 4dcfef7
1 parent b9324aa
commit 4dcfef7
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 8 deletions.
diff --git a/apps/server/src/main.ts b/apps/server/src/main.ts
@@ -18,7 +18,7 @@ async function bootstrap() {
   const config = new DocumentBuilder().setTitle('API Documentation').setDescription('NestJs API documentation').setVersion('1.0').build();
 
   const document = SwaggerModule.createDocument(app, config);
-  SwaggerModule.setup('api-docs', app, document);
+  SwaggerModule.setup('api/docs', app, document);
 
   await app.listen(process.env.PORT ?? 3000);
 }

diff --git a/apps/server/src/users/swagger/check-duplication.swagger.ts b/apps/server/src/users/swagger/check-duplication.swagger.ts
@@ -19,9 +19,19 @@ export const CheckDuplicationSwagger = {
       example: { type: 'success', data: { exists: 'true || false' } },
     },
   }),
-
   ApiResponse400: ApiResponse({
     status: 400,
-    description: '잘못된 요청: email 또는 nickname 하나만 제공해야 합니다.',
+    description: '잘못된 요청 (유효성 검사 실패)',
+    schema: {
+      example: {
+        type: 'fail',
+        error: {
+          message: {
+            errorType1: '이메일 또는 닉네임 하나만 요청해 주세요.',
+            errorType2: '올바른 이메일 형식이어야 합니다.',
+          },
+        },
+      },
+    },
   }),
 };
diff --git a/apps/server/src/users/swagger/create-user.swagger.ts b/apps/server/src/users/swagger/create-user.swagger.ts
@@ -15,11 +15,12 @@ export const CreateUserSwagger = {
     schema: {
       example: {
         type: 'fail',
-        error: '잘못된 요청입니다. 필드를 확인하세요.',
-        message: {
-          email: '이메일 형식이 올바르지 않습니다.',
-          nickname: '닉네임은 최소 3자 이상이어야 합니다.',
-          password: '비밀번호는 최소 8자 이상이어야 합니다.',
+        error: {
+          message: {
+            email: '이메일 형식이 올바르지 않습니다.',
+            nickname: '닉네임은 최소 3자 이상이어야 합니다.',
+            password: '비밀번호는 최소 8자 이상이어야 합니다.',
+          },
         },
       },
     },