✨ add api docs

kookmin-sw · Apr 25, 2024 · e5c4cca · e5c4cca
1 parent 275820c
commit e5c4cca
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 3 deletions.
diff --git a/src/profile/dto/profile.dto.ts b/src/profile/dto/profile.dto.ts
@@ -34,10 +34,14 @@ export class ProfileDto {
 
 export class GetProfileDto extends ProfileDto {
   @Type(() => ProfileDto)
-  @ApiProperty()
+  @ApiProperty({
+    type: [ProfileDto],
+  })
   likedByUsers: ProfileDto[] | [];
 
   @Type(() => ProfileDto)
-  @ApiProperty()
+  @ApiProperty({
+    type: [ProfileDto],
+  })
   likedProjects: ProfileDto[] | [];
 }
diff --git a/src/profile/profile.controller.ts b/src/profile/profile.controller.ts
@@ -12,7 +12,7 @@ import { ProfileService } from './profile.service';
 import { JwtAuthGuard } from 'src/user/user.guard';
 import { GetUser } from 'src/user/decorators/GetUser.decorator';
 import { Payload } from 'src/user/dto/jwt-payload.dto';
-import { ApiBearerAuth } from '@nestjs/swagger';
+import { ApiBearerAuth, ApiBody, ApiParam, ApiResponse } from '@nestjs/swagger';
 import { GetProfileDto, ProfileDto } from './dto/profile.dto';
 
 @Controller('profile')
@@ -22,6 +22,16 @@ export class ProfileController {
   constructor(private readonly profileService: ProfileService) {}
 
   @Get('/:id')
+  @ApiParam({
+    name: 'id',
+    description: 'userId',
+    type: 'number',
+  })
+  @ApiResponse({
+    status: 200,
+    description: 'Get a profile',
+    type: GetProfileDto,
+  })
   async getProfile(
     @Param('id') id: number,
     @GetUser() user: Payload,
@@ -35,6 +45,20 @@ export class ProfileController {
   }
 
   @Post('/:id')
+  @ApiParam({
+    name: 'id',
+    description: 'userId',
+    type: 'number',
+  })
+  @ApiBody({
+    description: 'Create a profile',
+    type: ProfileDto,
+  })
+  @ApiResponse({
+    status: 200,
+    description: 'Get a profile',
+    type: ProfileDto,
+  })
   async createProfile(
     @Param('id') id: number,
     @GetUser() user: Payload,
@@ -49,6 +73,20 @@ export class ProfileController {
   }
 
   @Put('/:id')
+  @ApiParam({
+    name: 'id',
+    description: 'userId',
+    type: 'number',
+  })
+  @ApiBody({
+    description: 'Create a profile',
+    type: ProfileDto,
+  })
+  @ApiResponse({
+    status: 200,
+    description: 'Get a profile',
+    type: ProfileDto,
+  })
   async updateProfile(
     @Param('id') id: number,
     @GetUser() user: Payload,