docs: swagger에서 [POST] /group 파라미터 이쁘게 (#17)

bo-an-bo · Apr 23, 2024 · 04aab43 · 04aab43
1 parent 13788ab
commit 04aab43
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 24 deletions.
diff --git a/src/group/dto/create-group.dto.ts b/src/group/dto/create-group.dto.ts
@@ -18,27 +18,27 @@ export class CreateGroupDto {
   })
   readonly description: string;
 
-  @ApiProperty({
-    required: false,
-    description: '부모임장 사용자의 ObjectId와 권한',
-    example: [
-      {
-        user: '60f4b3b3b3b3b3b3b3b3b3',
-        authorities: ['subManager'],
-      },
-    ],
-  })
-  readonly subManagers: [
-    {
-      user: string;
-      authorities: string[];
-    },
-  ];
-
-  @ApiProperty({
-    required: false,
-    description: '모임원 사용자의 ObjectId',
-    example: ['60f4b3b3b3b3b3b3b3b3b3'],
-  })
-  readonly members: string[];
+  // @ApiProperty({
+  //   required: false,
+  //   description: '부모임장 사용자의 ObjectId와 권한',
+  //   example: [
+  //     {
+  //       user: '60f4b3b3b3b3b3b3b3b3b3',
+  //       authorities: ['subManager'],
+  //     },
+  //   ],
+  // })
+  // readonly subManagers: [
+  //   {
+  //     user: string;
+  //     authorities: string[];
+  //   },
+  // ];
+  //
+  // @ApiProperty({
+  //   required: false,
+  //   description: '모임원 사용자의 ObjectId',
+  //   example: ['60f4b3b3b3b3b3b3b3b3b3'],
+  // })
+  // readonly members: string[] | null;
 }
diff --git a/src/group/dto/upload-group.dto.ts b/src/group/dto/upload-group.dto.ts
@@ -0,0 +1,13 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+import { CreateGroupDto } from './create-group.dto';
+
+export class UploadGroupDto extends CreateGroupDto {
+  @ApiProperty({
+    required: false,
+    description: '모임 회원 명단 엑셀 파일',
+    type: 'file',
+    format: 'binary',
+  })
+  readonly memberExcel: Express.Multer.File | undefined;
+}
diff --git a/src/group/group.controller.ts b/src/group/group.controller.ts
@@ -21,6 +21,7 @@ import { UpdateMemberDto } from '../member/dto/update-member.dto';
 import { Member } from '../member/member.decorators';
 import { CreateGroupDto } from './dto/create-group.dto';
 import { UpdateGroupDto } from './dto/update-group.dto';
+import { UploadGroupDto } from './dto/upload-group.dto';
 import { Group } from './group.decorators';
 import { GroupService } from './group.service';
 
@@ -36,7 +37,7 @@ export class GroupController {
     description: '모임을 생성합니다.',
   })
   @ApiFile('memberExcel')
-  @ApiBody({ type: CreateGroupDto })
+  @ApiBody({ type: UploadGroupDto })
   create(
     @Body() createGroupDto: CreateGroupDto,
     @UploadedFile() memberExcel: Express.Multer.File,