Express를 이용한 RESTful API 개발하기 AtoZ

deviantce

•

Node.js + Express

Node.js는 Chrome V8 JavaScript 엔진을 기반으로하는 JavaScript 런타임입니다. 웹 브라우저 외부에서 JavaScript를 실행할 수 있게 하므로, I/O 중심의 작업(예: 파일 시스템 작업, 네트워크 요청)에 이상적이며, 실시간 응용 프로그램을 구축하는 데 탁월합니다.

그러나 Node.js가 강력하다고는 하나, 웹 서버를 처음부터 구축하는 것은 복잡하고 시간이 많이 드는 작업입니다. 이러한 작업을 단순화하고 빠르게 프로토타입을 생성할 수 있게 도와주는 것이 Express 프레임워크입니다. Express는 Node.js의 가장 인기 있는 웹 프레임워크 중 하나로, 간단한 API부터 완전한 웹 애플리케이션까지 구축할 수 있습니다. 그것은 강력하고 유연하며, 미들웨어 스택을 사용하여 요청과 응답 사이에서 발생하는 작업을 쉽게 구성할 수 있습니다.

프레임워크는 특정한 어플리케이션을 개발하는 데 필요한 기본적인 구조를 제공하는 도구입니다. 즉, 프레임워크는 개발자가 새로운 어플리케이션을 만들 때 재사용 가능한 코드를 제공하며, 그럼으로써 개발 시간을 단축시키고 코드의 품질을 향상시키는 역할을 합니다.

프레임워크는 일반적으로 개발자가 특정 요구 사항에 맞게 코드를 추가하거나 수정하는 템플릿 형태로 제공됩니다. 이를 통해 프레임워크는 특정 프로그래밍 언어로 작성된 일련의 라이브러리 및 소프트웨어 컴포넌트를 제공하며, 이러한 컴포넌트는 프로그램의 기본 구조와 기능을 제공합니다.

프레임워크의 주요 장점은 다음과 같습니다:

  1. 코드 재사용: 프레임워크는 흔히 사용되는 기능을 제공하여, 개발자가 중복 코드를 작성하는 것을 방지합니다.
  2. 표준화: 프레임워크는 일관된 방식으로 애플리케이션을 구조화하고 코딩하는 데 도움이 됩니다. 이는 코드의 가독성을 향상시키고, 다른 개발자들이 코드를 이해하고 유지 관리하기 쉽게 만듭니다.
  3. 보안: 프레임워크는 보안 기능을 내장하고 있어, 애플리케이션의 보안을 향상시킵니다.
  4. 개발 속도: 프레임워크는 개발 과정을 빠르게 만들어, 개발자가 애플리케이션을 더 빨리 출시할 수 있게 도와줍니다.

프레임워크의 종류는 웹 개발, 모바일 앱 개발, 머신 러닝, 게임 개발 등 다양한 분야에서 사용됩니다. 프레임워크의 선택은 어플리케이션의 요구사항, 개발자의 경험 및 기술 스택, 사용하는 프로그래밍 언어 등에 따라 달라집니다.

이 포스트에서는 Node.js와 Express를 사용하여 RESTful API를 개발하는 방법을 알아보겠습니다. 기본적인 Javacript 지식은 있어야 합니다!

Node.js와 Express 설치 방법

Windows 환경에서의 설치 방법

  1. Node.js 설치: Node.js는 JavaScript 런타임입니다. Node.js를 설치하려면, 먼저 Node.js 공식 웹사이트(https://nodejs.org/)에 접속합니다. 웹사이트 메인 페이지에서 Windows 용 설치파일을 선택하고 다운로드합니다. 설치파일을 실행한 후, 나타나는 설치 마법사를 따라가며 필요한 설정을 선택하고 설치를 진행합니다. 기본적으로는 모든 설정을 기본값으로 두는 것이 가장 간단하며, 이렇게 하면 Node.js와 함께 npm(Node Package Manager)도 자동으로 설치됩니다.
  2. Express 설치: Express는 Node.js로 웹 애플리케이션을 쉽게 만들 수 있도록 도와주는 프레임워크입니다. Node.js가 성공적으로 설치된 후에는, 명령 프롬프트(시작 메뉴에서 ‘cmd’를 검색하여 실행)를 열고 npm install -g express-generator 명령을 입력하고 엔터를 눌러 실행합니다. 이 명령은 npm을 통해 Express 프레임워크를 전역(-g 옵션)으로 설치합니다. 이렇게 하면 어느 위치에서든 Express를 사용할 수 있게 됩니다.

MacOS 환경에서의 설치 방법

  1. Node.js 설치: MacOS 환경에서 Node.js를 설치하는 방법은 여러 가지가 있지만, 여기서는 Homebrew라는 패키지 매니저를 이용하는 방법을 소개하겠습니다. Homebrew가 설치되어 있지 않다면, 먼저 공식 웹사이트(https://brew.sh/)에서 설치 스크립트를 복사하여 터미널(스포트라이트에서 ‘터미널’을 검색하여 실행)에 붙여넣습니다. 설치 스크립트는 웹사이트 메인 페이지에서 복사할 수 있습니다. 스크립트를 터미널에 붙여넣은 후, 엔터를 눌러 Homebrew를 설치합니다. Homebrew 설치가 완료된 후에는, 터미널에 brew install node 명령을 입력하고 엔터를 눌러 Node.js를 설치합니다. 
brew install node
  1. Express 설치: Node.js를 설치한 후에는, 터미널에서 npm install -g express-generator 명령을 입력하고 엔터를 눌러 실행합니다. 이 명령은 npm을 통해 Express 프레임워크를 전역(-g 옵션)으로 설치합니다.
npm install -g express-generator

설치가 완료되었다면, 각 플랫폼의 명령 프롬프트나 터미널에서 node -v 및 npm -v 명령을 이용하여 Node.js와 npm의 설치를 확인할 수 있습니다. 또한 express -v 명령을 이용하여 Express의 설치를 확인할 수 있습니다.

Express를 이용한 서버 설정

  1. 프로젝트 디렉토리 생성 및 이동 콘솔에서 다음의 명령어를 실행하여 새로운 프로젝트 디렉토리를 생성하고, 해당 디렉토리로 이동합니다.
 mkdir my-express-app
 cd my-express-app
  1. Node.js 프로젝트 초기화 콘솔에서 다음의 명령어를 실행하여 새로운 Node.js 프로젝트를 초기화합니다.
 npm init -y

이 명령은 package.json 파일을 생성합니다. 이 파일은 프로젝트의 dependency와 스크립트 등을 관리하는 데 사용됩니다.

  1. Express 설치 콘솔에서 다음의 명령어를 실행하여 Express 프레임워크를 설치합니다.
   npm install express

이 명령은 node_modules 디렉토리를 생성하고, Express와 그 의존성을 설치합니다. 설치된 패키지 정보는 package.json 파일의 dependencies 항목에 추가됩니다.

  1. 서버 코드 작성 콘솔에서 텍스트 에디터를 열고, app.js라는 이름의 새로운 파일을 생성합니다. 이 파일에 다음의 코드를 작성합니다.
 const express = require('express');
 const app = express();
 const port = 3000;

 app.get('/', (req, res) => {
   res.send('Hello World!');
 });

 app.listen(port, () => {
   console.log(`Server running at http://localhost:${port}`);
 });

이 코드는 Express 앱을 생성하고, 루트 경로(/)에 대한 GET 요청을 처리하는 라우트를 정의합니다. 또한, 앱은 지정된 포트에서 리스닝하게 됩니다.

  1. 서버 실행 콘솔에서 다음의 명령어를 실행하여 서버를 시작합니다.
   node app.js

이제 웹 브라우저를 열고 http://localhost:3000 주소로 이동하면, ‘Hello World!’ 메시지를 볼 수 있습니다.

위의 단계를 통해 Express를 이용하여 웹 서버를 설정하는 방법을 알아보았습니다. 이제 이 설정을 바탕으로 API 라우트를 추가하거나, 미들웨어를 적용하는 등의 작업을 수행할 수 있습니다.

Express 폴더 구조 

myapp/
├── node_modules/
├── routes/
│ └── users.js
├── views/
├── app.js
├── package.json
└── package-lock.json
  • myapp/: 프로젝트의 루트 디렉토리입니다.
  • node_modules/: npm install 명령어를 실행하면 생성되는 디렉토리로, 설치된 모든 Node.js 패키지가 저장됩니다.
  • routes/: 라우트 핸들러가 저장되는 디렉토리입니다. 이 예제에서는 users.js라는 파일이 하나 있습니다.
  • views/: 애플리케이션의 뷰 템플릿이 저장되는 디렉토리입니다. 이 디렉토리는 웹 페이지를 렌더링하는데 사용되는 HTML 파일이나, 템플릿 엔진(e.g. EJS, Pug) 파일들이 저장됩니다.
  • app.js: 애플리케이션의 메인 파일입니다. 서버 설정과 라우트 설정 등이 이루어집니다.
  • package.json: 프로젝트의 메타데이터와 의존성 목록을 포함하는 파일입니다.
  • package-lock.json: 프로젝트의 의존성 트리에 대한 정확한 정보를 포함하는 파일로, npm install이 실행될 때 자동으로 생성됩니다.

이러한 구조는 개발자의 필요에 따라 추가적인 폴더나 파일을 포함할 수 있습니다. 예를 들어, 미들웨어, 모델, 서비스, 테스트 코드 등을 위한 별도의 디렉토리를 추가할 수 있습니다.

라우팅 처리 방법

Express에서 라우팅을 처리하는 방법은 다양합니다. 기본적으로 app.METHOD(PATH, HANDLER) 형식을 사용합니다. 여기서 METHOD는 HTTP 요청 메소드(get, post, put, delete 등)이며, PATH는 서버에서의 경로를, HANDLER는 해당 경로에 대한 요청이 들어왔을 때 실행될 콜백 함수입니다.

아래는 라우팅 처리의 예입니다.

// GET request
app.get('/about', (req, res) => {
  res.send('About page');
});

// POST request
app.post('/login', (req, res) => {
  res.send('Login page');
});

// PUT request
app.put('/user', (req, res) => {
  res.send('Update user');
});

// DELETE request
app.delete('/user', (req, res) => {
  res.send('Delete user');
});

위 코드에서는 각 경로와 HTTP 메소드에 따라 다른 라우트 핸들러를 설정했습니다. 이러한 방식으로 클라이언트의 요청에 따라 서버가 다른 동작을 수행하도록 설정할 수 있습니다.

RESTful API 개발을 위한 Express 라우팅

RESTful API를 Express로 개발하는 방법을 알아보겠습니다. 먼저, 간단한 Express 애플리케이션이 필요하므로 이전에 작성한 app.js 파일을 사용하겠습니다.

  1. 라우팅 모듈 생성 routes라는 새 디렉토리를 생성하고, 그 안에 users.js라는 새 파일을 생성합니다. 이 파일은 사용자 관련 라우트를 처리할 것입니다.
  2. 라우트 정의 users.js 파일에 다음의 코드를 작성합니다.
   const express = require('express');
   const router = express.Router();

   // GET /users
   router.get('/', (req, res) => {
     res.json({ message: 'Getting list of users' });
   });

   // GET /users/:id
   router.get('/:id', (req, res) => {
     res.json({ message: `Getting user with id ${req.params.id}` });
   });

   // POST /users
   router.post('/', (req, res) => {
     res.json({ message: 'Creating a new user' });
   });

   // PUT /users/:id
   router.put('/:id', (req, res) => {
     res.json({ message: `Updating user with id ${req.params.id}` });
   });

   // DELETE /users/:id
   router.delete('/:id', (req, res) => {
     res.json({ message: `Deleting user with id ${req.params.id}` });
   });

   module.exports = router;

이 코드는 /users 경로에 대한 다양한 HTTP 메서드(GET, POST, PUT, DELETE)를 처리하는 라우트를 정의합니다. :id 라우트 파라미터를 이용하여 특정 사용자에 대한 요청을 처리할 수 있습니다.

  1. 라우트 사용 이제 app.js 파일을 열고, 다음의 코드를 추가하여 라우트를 사용합니다.
 const usersRouter = require('./routes/users');

 app.use('/users', usersRouter);

이 코드는 앱이 /users 경로로 들어오는 모든 요청을 users 라우터에게 전달하도록 설정합니다.

  1. 서버 실행 콘솔에서 다음의 명령어를 실행하여 서버를 시작합니다.
   node app.js

이제 http://localhost:3000/users 주소로 들어오는 모든 요청이 users.js 파일의 라우트에 의해 처리되게 됩니다. 이를 통해 RESTful API를 Express로 간편하게 개발할 수 있습니다.

데이터베이스 연결 및 API 연동(MongoDB)

1. MongoDB와의 연결 설정

먼저, mongoose라는 npm 패키지를 사용하여 MongoDB와 연결하겠습니다.

npm install mongoose

이제 app.js에 다음 코드를 추가하여 MongoDB와의 연결을 설정합니다.

const mongoose = require('mongoose');

mongoose.connect('mongodb://localhost/mydatabase', { useNewUrlParser: true, useUnifiedTopology: true })
  .then(() => console.log('Connected to MongoDB'))
  .catch(err => console.error('Could not connect to MongoDB', err));

2. 스키마와 모델 생성

데이터베이스와 연동하기 위해서는 스키마와 모델이 필요합니다. models 폴더 아래에 item.js 파일을 만들고 다음과 같이 작성합니다.

const mongoose = require('mongoose');

const itemSchema = new mongoose.Schema({
  name: String,
  price: Number,
  // 여기에 필요한 필드를 추가
});

module.exports = mongoose.model('Item', itemSchema);

3. API에서 CRUD 작업 수행

이제 routes/api.js에서 CRUD 작업을 수행할 수 있습니다.

  • Create (POST)
  router.post('/items', (req, res) => {
    const item = new Item({
      // 여기에 데이터를 설정
    });
    item.save().then(result => res.send(result));
  });
  • Read (GET)
 router.get('/items', (req, res) => {
    Item.find().then(items => res.send(items));
  });
  • Update (PUT)
 router.put('/items/:id', (req, res) => {
    // 여기에 업데이트 로직을 작성
  });
  • Delete (DELETE)
  router.delete('/items/:id', (req, res) => {
    // 여기에 삭제 로직을 작성
  });

이로써, MongoDB와 연결하여 RESTful API를 통한 CRUD 작업을 수행하는 방법을 간단하게 알아봤습니다.

조금 더 구체적인 예시를 들어볼게요 . 여기서는 가상의 상품 데이터를 관리하는 API를 만들겠습니다.

1. 모델 정의

먼저, 상품 데이터를 정의할 스키마와 모델을 만듭니다. models/product.js 파일을 생성하고 다음과 같이 작성합니다.

const mongoose = require('mongoose');

const productSchema = new mongoose.Schema({
  name: { type: String, required: true },
  price: { type: Number, required: true },
  category: String,
  inStock: { type: Boolean, default: true }
});

module.exports = mongoose.model('Product', productSchema);

2. 라우팅 설정

routes/products.js 파일에 다음과 같이 라우팅을 설정합니다.

const express = require('express');
const router = express.Router();
const Product = require('../models/product');

// CREATE
router.post('/', (req, res) => {
  const product = new Product(req.body);
  product.save().then(result => res.send(result))
    .catch(err => res.status(400).send(err.message));
});

// READ ALL
router.get('/', (req, res) => {
  Product.find().then(products => res.send(products));
});

// READ SINGLE
router.get('/:id', (req, res) => {
  Product.findById(req.params.id).then(product => res.send(product));
});

// UPDATE
router.put('/:id', (req, res) => {
  Product.findByIdAndUpdate(req.params.id, req.body, { new: true })
    .then(product => res.send(product))
    .catch(err => res.status(400).send(err.message));
});

// DELETE
router.delete('/:id', (req, res) => {
  Product.findByIdAndDelete(req.params.id)
    .then(() => res.send({ message: 'Product deleted' }))
    .catch(err => res.status(400).send(err.message));
});

module.exports = router;

3. 서버 설정

app.js 파일에서 라우터를 추가하여 최종 설정을 마무리합니다.

const express = require('express');
const mongoose = require('mongoose');
const productRouter = require('./routes/products');

const app = express();

// DB 연결
mongoose.connect('mongodb://localhost/mydatabase', { useNewUrlParser: true, useUnifiedTopology: true });

// 미들웨어 설정
app.use(express.json());
app.use('/api/products', productRouter);

// 서버 실행
const port = process.env.PORT || 3000;
app.listen(port, () => console.log(`Server is running on port ${port}`));

이로써, MongoDB와 연결하여 상품 데이터를 관리하는 RESTful API를 완성했습니다. 클라이언트가 해당 엔드포인트에 요청을 보내면 상품 데이터의 생성, 조회, 수정, 삭제 작업을 수행할 수 있습니다.

MongoDB 및 mongoose에 관련된 내용은 따로 포스팅을 하겠습니다!

끝으로

RESTful API를 Node.js와 Express로 구축하면 많은 이점이 있습니다.

첫째, JavaScript를 사용하여 클라이언트와 서버 모두 개발할 수 있으므로, 개발 과정에서 언어를 전환하는 데 드는 부담을 줄일 수 있습니다.

둘째, Node.js는 비동기 I/O를 지원하므로 대량의 데이터를 처리하거나 동시에 많은 요청을 받을 때 효율적입니다. 이는 실시간 애플리케이션 또는 I/O 집중적인 작업에 적합합니다.

셋째, Express는 미들웨어를 지원하여 요청과 응답 사이의 기능을 쉽게 추가하거나 변경할 수 있습니다. 이는 코드의 재사용성과 유지 보수성을 향상시킵니다.

마지막으로, RESTful API는 웹의 기본 프로토콜인 HTTP를 기반으로 하므로, 다양한 플랫폼과 언어에서 손쉽게 사용할 수 있습니다. 이는 개발자가 API를 구현하고 사용하는데 유연성을 제공합니다.

Leave a Comment