RESTful API 설계 원칙과 구현

nest g mo users
nest g co users
nest g s users

import { Injectable } from '@nestjs/common';

export interface User {
  id: number;
  name: string;
  email: string;
}

@Injectable()
export class UsersService {
  private users: User[] = [
    { id: 1, name: 'Alice', email: 'alice@example.com' },
    { id: 2, name: 'Bob', email: 'bob@example.com' },
  ];
  private nextId = 3;

  findAll(): User[] {
    return this.users;
  }

  findOne(id: number): User | undefined {
    return this.users.find(user => user.id === id);
  }

  create(user: Omit<User, 'id'>): User {
    const newUser = { id: this.nextId++, ...user };
    this.users.push(newUser);
    return newUser;
  }

  update(id: number, updateUser: Partial<User>): User | undefined {
    const index = this.users.findIndex(user => user.id === id);
    if (index === -1) {
      return undefined;
    }
    this.users[index] = { ...this.users[index], ...updateUser };
    return this.users[index];
  }

  remove(id: number): boolean {
    const initialLength = this.users.length;
    this.users = this.users.filter(user => user.id !== id);
    return this.users.length < initialLength; // 삭제 성공 여부 반환
  }
}

import { IsString, IsEmail, IsNotEmpty } from 'class-validator';

export class CreateUserDto {
  @IsString()
  @IsNotEmpty()
  name: string;

  @IsEmail()
  @IsNotEmpty()
  email: string;
}

import { IsString, IsEmail, IsOptional } from 'class-validator';
import { PartialType } from '@nestjs/mapped-types'; // npm install @nestjs/mapped-types

export class UpdateUserDto extends PartialType(CreateUserDto) {
  // PartialType을 사용하면 CreateUserDto의 모든 필드가 선택적으로 변환됩니다.
  // 즉, name?: string; email?: string; 와 동일합니다.
}

import { Controller, Get, Post, Body, Param, Patch, Delete, HttpCode, HttpStatus, NotFoundException } from '@nestjs/common';
import { UsersService } from './users.service';
import { CreateUserDto } from './dto/create-user.dto';
import { UpdateUserDto } from './dto/update-user.dto';

@Controller('users') // 기본 경로: /users
export class UsersController {
  constructor(private readonly usersService: UsersService) {}

  // GET /users - 모든 사용자 조회
  @Get()
  findAll() {
    return this.usersService.findAll();
  }

  // GET /users/:id - 특정 사용자 조회
  @Get(':id')
  findOne(@Param('id') id: string) {
    const user = this.usersService.findOne(+id); // +id로 문자열을 숫자로 변환
    if (!user) {
      throw new NotFoundException(`User with ID ${id} not found`);
    }
    return user;
  }

  // POST /users - 새 사용자 생성
  @Post()
  @HttpCode(HttpStatus.CREATED) // 201 Created 상태 코드 반환
  create(@Body() createUserDto: CreateUserDto) {
    return this.usersService.create(createUserDto);
  }

  // PATCH /users/:id - 특정 사용자 부분 수정
  @Patch(':id')
  update(@Param('id') id: string, @Body() updateUserDto: UpdateUserDto) {
    const updatedUser = this.usersService.update(+id, updateUserDto);
    if (!updatedUser) {
      throw new NotFoundException(`User with ID ${id} not found`);
    }
    return updatedUser;
  }

  // DELETE /users/:id - 특정 사용자 삭제
  @Delete(':id')
  @HttpCode(HttpStatus.NO_CONTENT) // 204 No Content 상태 코드 반환 (성공적으로 삭제되었으나 응답 본문 없음)
  remove(@Param('id') id: string) {
    const removed = this.usersService.remove(+id);
    if (!removed) {
      throw new NotFoundException(`User with ID ${id} not found`);
    }
    // 204 No Content는 본문 없이 응답하므로 return 값은 무시됩니다.
  }
}

import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { UsersModule } from './users/users.module'; // UsersModule 임포트

@Module({
  imports: [UsersModule], // UsersModule 추가
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { ValidationPipe } from '@nestjs/common'; // ValidationPipe 임포트

async function bootstrap() {
  const app = await NestFactory.create(AppModule);

  // 전역 유효성 검사 파이프 설정
  app.useGlobalPipes(new ValidationPipe({
    whitelist: true, // DTO에 정의되지 않은 속성은 자동으로 제거
    forbidNonWhitelisted: true, // DTO에 정의되지 않은 속성이 있으면 에러 발생
    transform: true, // DTO 타입으로 자동 변환 (예: URL 파라미터 문자열을 숫자 ID로)
  }));

  await app.listen(3000);
}
bootstrap();