Node.js REST API 구축 기초 개념 및 활용법

Node.js REST API 구축 기초 개념

최근 웹 개발 분야에서 API는 필수적인 요소로 자리잡고 있습니다. REST API는 웹 애플리케이션에서 클라이언트와 서버 간에 효과적으로 데이터를 주고받기 위한 표준적인 방법론입니다. Node.js는 이러한 REST API를 구축하기 위한 훌륭한 플랫폼으로, 빠른 개발 속도와 강력한 성능을 자랑합니다. 본 글에서는 Node.js를 사용하여 REST API를 구축하는 기본적인 방법과 활용 사례를 살펴보도록 하겠습니다.

REST API란 무엇인가?

REST(Representational State Transfer)는 네트워크 상에서 자원(resource)을 URI(Uniform Resource Identifier)를 통해 주고받기 위한 아키텍처 스타일입니다. API(Application Programming Interface)는 이러한 RESTful 원칙을 바탕으로 클라이언트가 서버에 요청을 보내고, 서버는 이에 대한 응답을 반환하는 방식으로 동작합니다.

Node.js와 Express.js를 활용한 REST API 구축

Node.js는 비동기 I/O를 지원하는 서버 사이드 자바스크립트 환경으로, 효율적인 데이터 처리를 가능하게 합니다. Express.js는 Node.js를 기반으로 한 웹 프레임워크로, REST API를 간편하게 구현할 수 있는 기능을 제공합니다.

Express 설치하기

Express.js를 사용하기 위해서는 먼저 해당 프레임워크를 프로젝트에 설치해야 합니다. 다음과 같은 명령어로 설치할 수 있습니다:

npm install express --save

기본 서버 설정

Express를 활용해 간단한 웹 서버를 설정할 수 있습니다. 아래의 코드는 포트 3001에서 서버를 구동하는 예시입니다:

const express = require('express');
const app = express();
const server = app.listen(3001, () => {
 console.log('서버가 시작되었습니다: localhost:3001');
});

API 엔드포인트 만들기

다음으로, 특정 경로에 대한 요청을 처리하는 API 엔드포인트를 설정해보겠습니다. 아래의 코드는 ‘/api/user/:type’ 경로로 GET 요청을 처리합니다:

app.get('/api/user/:type', (req, res) => {
 const type = req.params.type;
 if (type === 'seoul') {
  const data = [{ name: '홍길동', city: 'seoul' }, { name: '김철수', city: 'seoul' }];
  res.send(data);
 } else if (type === 'jeju') {
  const data = [{ name: '박지성', city: 'jeju' }, { name: '손흥민', city: 'jeju' }];
  res.send(data);
 } else {
  res.status(404).send('해당 타입을 찾을 수 없습니다.');
 }
});

API 키 인증 추가하기

보안을 강화하기 위해 API 키 인증을 추가할 수 있습니다. UUID 기반의 API 키를 생성하여 사용자가 요청할 때 올바른 키를 제공해야만 데이터에 접근할 수 있도록 설정합니다. uuid-apikey 모듈을 사용하여 API 키를 검증할 수 있습니다:

npm install uuid-apikey --save

API 키 검증 로직 구현

아래의 코드는 API 키 검증을 포함한 예시입니다:

const uuidAPIKey = require('uuid-apikey');
const key = {
 apiKey: '당신의-API-키',
 uuid: '당신의-UUID'
};
app.get('/api/user/:apikey/:type', (req, res) => {
 const { apikey, type } = req.params;
 if (!uuidAPIKey.isAPIKey(apikey) || !uuidAPIKey.check(apikey, key.uuid)) {
  return res.status(401).send('유효하지 않은 API 키입니다.');
 }
 // 유효한 키일 경우 데이터 반환
 // ... 이전의 데이터 처리 로직
});

Postman을 이용한 API 테스트

개발이 완료된 API는 Postman과 같은 도구를 사용하여 테스트할 수 있습니다. Postman을 통해 GET 요청을 보내고, 응답 데이터를 검증하는 과정을 통해 서버의 동작을 확인할 수 있습니다. 예를 들어, http://localhost:3001/api/user/seoul로 요청을 보내면 서울에 거주하는 사용자 데이터가 반환됩니다.

결론

Node.js와 Express를 이용한 REST API 구축은 비교적 간단하며, 높은 유연성과 성능을 제공합니다. API 개발에 있어 권장되는 보안 조치를 적용하고, 다양한 기능을 추가하는 과정을 통해 더욱 완성도 높은 서비스를 만들 수 있습니다. 위에서 제시한 기본 예제들을 바탕으로 감각적인 API를 구축해보시기 바랍니다.

자주 찾으시는 질문 FAQ