🎯 Postman을 활용하여 Express의 CRUD 기능을 구현하고 테스트해보았습니다.

📙 Today I Learned

postman

API를 개발하고 사용하는 플랫폼으로 API 라이프사이클의 각 단계를 간소화하고 협업을 원활하게 하여 더 나은 API를 더 빠르게 만들 수 있도록 돕습니다. 출처: postman

🧐 왜 postman을 사용할까?

API 요청과 결과를 간편하게 확인할 수 있기 때문입니다. (브라우저에서 확인할 수 없는 POST, PUT, DELETE 요청을 쉽게 확인 가능)

API에서 데이터 전송 방법 3가지

• URL 파라미터 (Path Parameter)

  • 예시: /youtubers/:id

• URL 쿼리 스트링 (Query String)

  • 예시: /movies?genre=horror

• HTTP 바디 (Request Body)

  • POST, PUT 요청에서 JSON으로 데이터를 보낼 수 있습니다.

도서 API 예제

// express 모듈 셋팅
const express = require('express');
const app = express();
app.listen(3000);

// 데이터 셋팅
let book1 = {
  title: '모순',
  author: '양귀자',
  pages: 320,
};

let book2 = {
  title: '데미안',
  author: '헤르만 헤세',
  pages: 270,
};

let book3 = {
  title: '어린 왕자',
  author: '생텍쥐페리',
  pages: 120,
};

let db = new Map(); // key-value
let id = 1;
db.set(id++, book1);
db.set(id++, book2);
db.set(id++, book3);

// REST API 설계

// 전체 조회
app.get('/books', (req, res) => {
  res.json({
    message: '책 전체 조회',
  });
});

// 개별 조회
app.get('/books/:id', (req, res) => {
  let { id } = req.params;
  id = parseInt(id);
  // console.log(id);
  const book = db.get(id);
  if (!book) {
    res.json({
      message: '없는 책입니다.',
    });
  } else {
    book.id = id; // book['id'] = id;
    res.json(book);
  }
});

// JSON 요청을 처리하는 미들웨어
app.use(express.json());

// POST 요청 (책 추가)
app.post('/books', (req, res) => {
  // body에 숨겨져서 들어온 데이터를 화면에 출력
  db.set(id++, req.body);
  res.json({
    message: `${db.get(id - 1).title} 책이 추가되었습니다.`,
  });
});

책 데이터 저장

• db.set(id++, book) → 책 데이터를 id와 함께 Map에 저장합니다.
  
  

미들웨어 설정

• express.json() → POST 요청에서 JSON 데이터를 읽을 수 있도록 설정합니다. 이 설정으로 req.body 의 값이 undefined 에서 JSON으로 변형됩니다.
  
  

  미들웨어(Middleware)란?

  요청과 응답을 중간 역할을 하는 함수로 API 전처리 작업(로그, 보안, 데이터 변환, 요청 차단) 등을 해줍니다.

  🧐 왜 필요한걸까?

  일일이 각 API에서 직접 처리하면 코드가 너무 복잡지기 때문에 중간 처리 과정이 필요한 것입니다.

새로운 책 추가

• db.set(id++, req.body); → 책 정보를 새로운 id와 함께 저장합니다.

postman에서 POST를 사용하여 새로운 책을 추가한 결과 화면

새로 추가된 책을 GET을 사용하여 불러온 결과 화면

---

✏️ 한 줄 회고

미들웨어의 역할로 JSON을 다룰 수 있다는 점이 신기했고, postman으로 브라우저에서는 확인할 수 없는 post 등의 출력 결과를 볼 수 있어 편리했습니다.