[typescript] REST API 호출 시 요청 데이터 유효성 검사 방법

12 Dec 2023

typescript

REST API 호출 시 요청 데이터 유효성 검사 방법

소개
요청 데이터 유효성 검사
Joi를 사용한 스키마 기반 데이터 유효성 검사
TypeScript에서 Joi를 사용한 유효성 검사 예시
마무리

1. 소개

REST API로 데이터를 보낼 때, 클라이언트에서 보내는 요청 데이터의 유효성을 검사하는 것은 매우 중요합니다. 잘못된 데이터가 API로 전송되면 예기치 않은 동작이 발생할 수 있으며, 보안에 취약해질 수도 있습니다.

2. 요청 데이터 유효성 검사

요청 데이터의 유효성을 검사하기 위해, 스키마 기반의 데이터 유효성 검사 도구를 사용하는 것이 일반적입니다. 이를 통해 요청 데이터의 형식, 값의 범위, 필수 필드 등을 체크할 수 있습니다.

3. Joi를 사용한 스키마 기반 데이터 유효성 검사

Joi는 Node.js를 위한 객체 스키마 기반 검증 라이브러리로, REST API에서 요청 데이터의 유효성을 검사하기 위해 많이 사용됩니다. Joi를 사용하면 데이터의 유효성을 간단하게 검사할 수 있으며, 에러 메시지도 쉽게 생성할 수 있습니다.

4. TypeScript에서 Joi를 사용한 유효성 검사 예시

아래는 TypeScript에서 Joi를 사용한 간단한 유효성 검사 예시입니다.

import * as Joi from 'joi';

// 스키마 정의
const schema = Joi.object({
  username: Joi.string().alphanum().min(3).max(30).required(),
  email: Joi.string().email().required(),
  age: Joi.number().integer().min(18).max(99).required(),
});

// 데이터 유효성 검사
const data = {
  username: 'john_doe',
  email: 'john.doe@example.com',
  age: 30,
};

const { error } = schema.validate(data);
if (error) {
  console.error('유효성 검사 에러:', error.details);
} else {
  console.log('유효한 데이터:', data);
}

5. 마무리

이제 REST API를 호출할 때 요청 데이터의 유효성을 검사하는 방법에 대해 알게 되었습니다. 요청 데이터를 검사하여 안정적이고 안전한 API를 구축할 수 있도록 Joi와 같은 유효성 검사 도구를 적절히 활용해보세요.

이상으로 REST API 호출 시 요청 데이터의 유효성 검사 방법에 대해 알아보았습니다.

참고 문헌:

Joi 공식 문서: https://joi.dev/documentation/

관련 용어:

REST API: Representational State Transfer API. 네트워크를 통해 시스템 자원을 다루기 위한 소프트웨어 아키텍처 스타일.