REST API를 호출할 때 인자의 유효성을 검사하는 것은 중요합니다. 타입스크립트를 사용하면 이를 간단하고 효과적으로 수행할 수 있습니다. 이번 게시물에서는 타입스크립트에서 REST API 호출 시 인자의 유효성을 검사하는 방법을 살펴보겠습니다.

타입 정의를 활용한 인자 유효성 검사

타입스크립트에서는 강력한 타입 시스템을 제공하며, 이를 이용하여 함수 호출 시 인자의 유효성을 검사할 수 있습니다.

예를 들어, REST API로 유저를 생성하는 함수를 작성할 때, 다음과 같이 타입 정의를 활용하여 인자의 유효성을 검사할 수 있습니다.

type User = {
  name: string;
  email: string;
  age: number;
}

function createUser(user: User) {
  // 유효성 검사
  if (!user.name || !user.email || user.age <= 0) {
    throw new Error('Invalid user information');
  }
  // REST API 호출
  // ...
}

위 예제에서 User 타입을 정의하여 유효성 검사를 진행한 후, REST API를 호출하는 것을 볼 수 있습니다.

라이브러리 활용

때로는 라이브러리를 활용하여 더욱 쉽고 간편하게 인자의 유효성을 검사할 수 있습니다. class-validator와 같은 라이브러리를 사용하면 더욱 다양한 유효성 규칙을 적용할 수 있습니다.

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

class CreateUserDto {
  @IsNotEmpty()
  name: string;

  @IsEmail()
  email: string;

  @Min(1)
  age: number;
}

function createUser(user: CreateUserDto) {
  // 유효성 검사
  // ...
  // REST API 호출
  // ...
}

위 예제에서는 class-validator 라이브러리를 사용하여 CreateUserDto 클래스를 통해 유효성을 검사하는 것을 볼 수 있습니다.

마무리

타입스크립트를 사용하여 REST API 호출 시 인자의 유효성을 검사하는 방법에 대해 알아보았습니다. 타입스크립트의 강력한 타입 시스템과 라이브러리를 활용하여, 안전하고 효과적으로 REST API를 호출할 수 있습니다.

이를 통해 코드의 신뢰성을 높이고 유지 보수성을 향상시킬 수 있습니다.

참고 자료

• 타입스크립트 공식 문서
• class-validator 라이브러리 GitHub 저장소