[WebDev][Node.js] Node.js로 REST API 개발하기 (CRUD)

2025.01.30 - [개발 Code/웹개발 WebDev] - [WebDev][Node.js] Node.js환경 설정 및 Express.js를 활용한 서버 만들기

1. REST API란?

---

• REST(Representational State Transfer) API는 HTTP 프로토콜을 기반으로 클라이언트와 서버가 데이터를 주고받는 방식이다.
• CRUD(Create, Read, Update, Delete) 기능을 통해 데이터를 관리할 수 있다.

---

2. Express.js를 활용한 REST API 구축

---

2.1. 프로젝트 초기화 및 필수 패키지 설치

• 새로운 프로젝트 폴더를 생성하고 VSCode에서 해당 폴더로 이동함:

mkdir my-rest-api
cd my-rest-api

• npm을 사용하여 프로젝트를 초기화함:

npm init -y

• Express.js 및 기타 필요한 라이브러리를 설치함:

npm install express body-parser cors

2.2. 기본 서버 설정

• server.js 파일을 생성하고 다음과 같이 Express 서버를 설정함:

const express = require('express');
const bodyParser = require('body-parser');
const cors = require('cors');

const app = express();
const PORT = 3000;

app.use(cors());
app.use(bodyParser.json());

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

728x90

반응형

2.3. RESTful API 엔드포인트 구현 (CRUD 기능)

1) 데이터 저장소(Mock Data)

const users = [];

2) 사용자 목록 조회 (Read)

app.get('/users', (req, res) => {
    res.json(users);
});

3) 새로운 사용자 추가 (Create)

app.post('/users', (req, res) => {
    const user = req.body;
    users.push(user);
    res.status(201).json(user);
});

4) 사용자 정보 수정 (Update)

app.put('/users/:id', (req, res) => {
    const { id } = req.params;
    const updatedUser = req.body;
    const index = users.findIndex(user => user.id === parseInt(id));
    if (index !== -1) {
        users[index] = updatedUser;
        res.json(updatedUser);
    } else {
        res.status(404).json({ message: 'User not found' });
    }
});

5) 사용자 삭제 (Delete)

app.delete('/users/:id', (req, res) => {
    const { id } = req.params;
    const index = users.findIndex(user => user.id === parseInt(id));
    if (index !== -1) {
        users.splice(index, 1);
        res.json({ message: 'User deleted' });
    } else {
        res.status(404).json({ message: 'User not found' });
    }
});

---

3. REST API 테스트

---

3.1. Postman을 활용한 API 테스트

• Postman 설치: Postman 공식 웹사이트에서 다운로드 후 설치함
• 서버 실행: 터미널에서 다음 명령어 실행:

node server.js // nodemon server.js

• GET 요청 테스트:
  • Postman을 열고 GET http://localhost:3000/users 요청을 보냄
  • 빈 배열 [ ] 이 응답으로 오면 정상 동작
• POST 요청 테스트:
  • Postman에서 POST http://localhost:3000/users 요청을 선택
  • Body 탭에서 raw를 선택하고 JSON 형식으로 데이터 입력 후 Send 버튼을 눌러 요청을 보내고, 추가된 데이터가 응답으로 오는지 확인:

{
	id": 1, 
	"name": "5hr1rnp", 
	"email": "5hr1rnp@money.com" 
}

• PUT 요청 테스트:
  • PUT http://localhost:3000/users/1 요청을 선택.
  • Body에 다음 데이터를 입력하고 전송 후 변경된 데이터가 응답으로 오는지 확인:

{
	"id": 1,
	"name": "5hr1rnp",
	"email": "5hr1rnp@moremoney.com" 
}

• DELETE 요청 테스트:
  • DELETE http://localhost:3000/users/1 요청을 보냄.
  • 응답으로 { "message": "User deleted" } 가 오면 정상 동작함.

---

4. 마무리

---

• Node.js와 Express를 활용하여 기본적인 CRUD 기능을 제공하는 REST API를 구현하였음
• 이후에는 데이터베이스를 연동하여 더욱 확장된 API를 개발하는 방법을 다룰 예정임