Refactor: remove appController, edit api-docs (#35)

* Refactor: remove appController, edit api-docs

- 앱 컨트롤러 삭제
    - 본인 조회는 user controller로 이관
- 스웨거를 위한 태그 추가
- User엔티티를, UserResponseDto로 변환하는 함수 추가

* chore

chore

src/app.module.ts

@@ -6,8 +6,6 @@ import { MikroOrmModule } from '@mikro-orm/nestjs';
 import { LoggerMiddleware } from 'src/core/intercepters/logging.interceptor';
 import { InviteLinkModule } from 'src/invite-link/invite-link.module';
 
-import { AppController } from './app.controller';
-import { AppService } from './app.service';
 import { AuthModule } from './auth/auth.module';
 import { getNodeEnv, isIgnoreEnvFile } from './common/helper/env.helper';
 import { envValidation } from './common/helper/env.validation';
@@ -39,8 +37,8 @@ import { UtilModule } from './util/util.module';
     PlaceModule,
     InviteLinkModule,
   ],
-  controllers: [AppController],
-  providers: [AppService],
+  controllers: [],
+  providers: [],
 })
 export class AppModule implements NestModule {
   configure(consumer: MiddlewareConsumer): void {

src/map/map.controller.ts

@@ -2,7 +2,6 @@ import {
   BadRequestException,
   Body,
   Controller,
-  Delete,
   Get,
   Param,
   Patch,
@@ -38,7 +37,7 @@ export class MapController {
 
   @Post()
   @ApiOkResponse({ type: MapItemForUserDto })
-  @ApiOperation({ summary: '새 지도를 생성합니다' })
+  @ApiOperation({ summary: '새 지도를 생성합니다.' })
   @ApiBearerAuth()
   @UseAuthGuard([UserRole.USER])
   create(@Body() createMapDto: CreateMapDto, @CurrentUser() user: User) {
@@ -53,7 +52,7 @@ export class MapController {
   }
 
   @Get()
-  @ApiOperation({ summary: '사용자가 속해있는 지도를 가져옵니다' })
+  @ApiOperation({ summary: '사용자가 속해있는 지도를 가져옵니다.' })
   @ApiOkResponse({ type: [MapItemForUserDto] })
   @ApiBearerAuth()
   @UseAuthGuard([UserRole.USER])
@@ -90,6 +89,10 @@ export class MapController {
   // }
 
   @Post(':id/invite-links')
+  @ApiOperation({
+    summary: '지도의 초대링크를 생성합니다.',
+    description: '유효기간은 7일로 설정되어 있습니다.',
+  })
   @ApiResponse({ type: InviteLinkResponseDto })
   @ApiBearerAuth()
   @UseMapRoleGuard([UserMapRole.ADMIN])

src/user/dtos/user-response.dto.ts

@@ -30,3 +30,14 @@ export class UserResponseDto implements Partial<Omit<User, 'userMap'>> {
   @IsNotEmpty()
   role: UserRoleValueType;
 }
+
+export function toUserResponseDto(user: User): UserResponseDto {
+  const userResponse = new UserResponseDto();
+  userResponse.id = user.id;
+  userResponse.nickname = user.nickname;
+  userResponse.provider = user.provider;
+  userResponse.providerId = user.providerId;
+  userResponse.role = user.role;
+
+  return userResponse;
+}

src/user/user.controller.ts

@@ -7,49 +7,68 @@ import {
   Patch,
   Query,
 } from '@nestjs/common';
-import { ApiBearerAuth, ApiOkResponse, ApiTags } from '@nestjs/swagger';
+import {
+  ApiBearerAuth,
+  ApiExcludeEndpoint,
+  ApiOkResponse,
+  ApiOperation,
+  ApiTags,
+} from '@nestjs/swagger';
 
 import { UseAuthGuard } from 'src/common/decorators/auth-guard.decorator';
 import { CurrentUser } from 'src/common/decorators/user.decorator';
 import { User, UserRole } from 'src/entities';
 
 import { UpdateUserRequestDto } from './dtos/update-user.dto';
-import { UserResponseDto } from './dtos/user-response.dto';
+import { UserResponseDto, toUserResponseDto } from './dtos/user-response.dto';
 import { UserService } from './user.service';
 
 @ApiTags('users')
 @Controller('users')
 export class UserController {
   constructor(private readonly userService: UserService) {}
 
-  @Get(':id')
+  @Get('me')
+  @ApiOperation({ summary: '내 정보를 조회합니다.' })
   @UseAuthGuard([UserRole.USER])
   @ApiOkResponse({ type: UserResponseDto })
   @ApiBearerAuth()
-  async findOne(@Param('id') id: string) {
-    const user = await this.userService.findOne({ id: +id });
-    return user;
+  getMe(@CurrentUser() user: User): UserResponseDto {
+    return toUserResponseDto(user);
   }
 
-  @Patch()
+  @Patch('me')
+  @ApiOperation({ summary: '내 정보를 수정합니다.' })
   @UseAuthGuard([UserRole.USER])
   @ApiOkResponse({ type: UserResponseDto })
   @ApiBearerAuth()
-  async update(
+  async updateMe(
     @Body() updateUserDto: UpdateUserRequestDto,
     @CurrentUser() user: User,
-  ) {
-    return await this.userService.update(+user.id, updateUserDto);
+  ): Promise<UserResponseDto> {
+    const updatedUser = await this.userService.update(user.id, user);
+    return toUserResponseDto(updatedUser);
+  }
+
+  @Get(':id')
+  @UseAuthGuard([UserRole.USER])
+  @ApiOkResponse({ type: UserResponseDto })
+  @ApiBearerAuth()
+  async findOne(@Param('id') id: string): Promise<UserResponseDto> {
+    const user = await this.userService.findOne({ id: +id });
+    return toUserResponseDto(user);
   }
 
   @Delete(':id')
   @ApiOkResponse({ type: Number })
   @ApiBearerAuth()
+  @ApiExcludeEndpoint()
   async remove(@Param('id') id: string) {
     return this.userService.remove(+id);
   }
 
   @Get('check/nickname')
+  @ApiOperation({ summary: '닉네임 중복체크합니다.' })
   @ApiOkResponse({})
   async checkDuplicateNickname(@Query('nickname') nickname: string) {
     return this.userService.checkDuplicateNickname(nickname);