웹 개발의 기초: REST API 설계와 구현

웹 개발의 기초: REST API 설계와 구현

안녕하세요, 코딩 악어입니다! 🐊 오늘은 웹 개발에서 중요한 부분 중 하나인 REST API의 설계와 구현에 대해 알아보겠습니다. REST API는 클라이언트와 서버 간의 통신을 효율적으로 관리하는 데 필수적인 요소입니다.

1. REST API란 무엇인가?

REST(Representational State Transfer) API는 HTTP 프로토콜을 기반으로 하는 아키텍처 스타일입니다. 클라이언트가 요청을 보내고, 서버가 응답하는 방식으로 동작하며, 주로 JSON 형식을 사용하여 데이터를 교환합니다.

2. REST API의 기본 원칙

REST API를 설계할 때는 다음과 같은 기본 원칙을 준수해야 합니다:

• 무상태성: 각 요청은 독립적이어야 하며, 서버는 클라이언트의 이전 요청 상태를 저장하지 않아야 합니다.
• 클라이언트-서버 구조: 클라이언트와 서버는 서로 독립적으로 개발되고 유지보수되어야 합니다.
• 캐시 처리: 응답은 캐시 가능해야 하며, 이를 통해 성능을 향상시킬 수 있습니다.
• 계층화 시스템: 클라이언트는 여러 계층의 서버와 상호작용할 수 있으며, 각 계층은 독립적으로 유지보수될 수 있습니다.

3. REST API 설계

REST API를 설계할 때는 다음과 같은 요소를 고려해야 합니다:

• 자원(Resource): URI를 통해 고유하게 식별되는 엔티티입니다. 예를 들어, /users는 사용자 자원을 나타냅니다.
• HTTP 메서드: 자원에 대한 작업을 정의합니다. 주요 메서드로는 GET, POST, PUT, DELETE 등이 있습니다.
• 상태 코드: 클라이언트 요청의 결과를 나타냅니다. 예를 들어, 200 OK는 요청이 성공적으로 처리되었음을 의미합니다.

4. REST API 구현 예제

간단한 사용자 관리 REST API를 Node.js와 Express를 사용하여 구현해 보겠습니다.

javascript

const express = require('express');
const app = express();
app.use(express.json());

let users = [
    { id: 1, name: 'Alice' },
    { id: 2, name: 'Bob' },
];

// 사용자 목록 조회
app.get('/users', (req, res) => {
    res.status(200).json(users);
});

// 사용자 추가
app.post('/users', (req, res) => {
    const newUser = req.body;
    users.push(newUser);
    res.status(201).json(newUser);
});

// 사용자 수정
app.put('/users/:id', (req, res) => {
    const id = parseInt(req.params.id);
    const updatedUser = req.body;
    users = users.map(user => (user.id === id ? updatedUser : user));
    res.status(200).json(updatedUser);
});

// 사용자 삭제
app.delete('/users/:id', (req, res) => {
    const id = parseInt(req.params.id);
    users = users.filter(user => user.id !== id);
    res.status(204).send();
});

app.listen(3000, () => {
    console.log('Server is running on port 3000');
});

결론

REST API는 웹 개발에서 매우 중요한 역할을 하며, 효율적인 통신을 위해 반드시 알아야 할 개념입니다. 이번 포스팅에서는 REST API의 기본 원칙과 설계, 그리고 Node.js와 Express를 사용한 구현 예제를 소개해 드렸습니다. 꾸준히 연습하고 다양한 프로젝트를 통해 실력을 키워보세요!