[javascript] Express.js에서의 Rest API 설계 방법

04 Dec 2023

javascript

Express.js는 자바스크립트로 구현된 웹 애플리케이션 프레임워크로, Rest API를 쉽게 구현할 수 있는 강력한 도구입니다. 이 글에서는 Express.js에서 Rest API를 설계하는 방법에 대해 알아보겠습니다.

1. 라우팅(Routing) 설정

Express.js에서 Rest API를 설계하기 위해 먼저 라우팅을 설정해야 합니다. 라우팅은 클라이언트의 요청에 따라 적절한 핸들러 함수를 호출하는 역할을 합니다. Express.js에서는 app.get, app.post, app.put, app.delete 등의 메소드를 이용해 라우팅을 설정할 수 있습니다.

예를 들어, /users 엔드포인트에 대한 GET 요청을 처리하는 라우팅은 다음과 같이 설정할 수 있습니다.

app.get('/users', (req, res) => {
  // 핸들러 함수
});

2. 핸들러 함수 작성

라우팅 설정이 완료되면, 해당 엔드포인트의 요청을 처리하는 핸들러 함수를 작성해야 합니다. 핸들러 함수는 클라이언트로부터 받은 요청을 처리하고 응답을 반환하는 역할을 합니다.

app.get('/users', (req, res) => {
  // 데이터베이스에서 사용자 목록을 조회하고
  // 조회된 결과를 클라이언트에게 응답한다.
});

핸들러 함수에서는 주로 데이터베이스와의 상호작용, 데이터 처리, 응답 포맷팅 등을 처리합니다.

3. RESTful 설계 원칙 따르기

Rest API를 설계할 때는 RESTful 디자인 원칙을 따라야 합니다. RESTful 디자인 원칙에는 다음과 같은 내용이 포함됩니다.

엔드포인트는 명사로 구성되어야 한다. (예: /users, /products)
HTTP 메소드를 사용하여 요청 목적을 나타낸다. (GET은 조회, POST는 생성, PUT은 수정, DELETE는 삭제)
URL 경로에서 동적인 데이터는 파라미터로 전달한다. (예: /users/:id, /products/:id)
응답은 JSON 형태로 반환한다.

예를 들어, 사용자 정보를 조회하는 API는 다음과 같이 설계할 수 있습니다.

GET /users            // 모든 사용자 정보 조회
GET /users/:id        // 특정 사용자 정보 조회
POST /users           // 사용자 정보 생성
PUT /users/:id        // 특정 사용자 정보 수정
DELETE /users/:id     // 특정 사용자 정보 삭제

4. 에러 처리

Rest API에서는 예외 상황에 대한 적절한 처리가 중요합니다. Express.js에서는 try-catch 문을 사용하여 예외를 처리하고, 클라이언트에게 적절한 오류 응답을 전달해야 합니다.

app.get('/users/:id', (req, res) => {
  try {
    // 데이터베이스에서 사용자 정보를 조회하고
    // 만약 사용자가 존재하지 않는 경우 오류 응답을 반환한다.
  } catch (error) {
    // 오류 응답을 반환한다. (예: 500 Internal Server Error)
  }
});

마무리

이제 Express.js를 사용하여 Rest API를 설계하는 방법에 대해 알아보았습니다. Rest API를 설계할 때는 라우팅 설정, 핸들러 함수 작성, RESTful 디자인 원칙, 에러 처리 등을 고려해야 합니다. Express.js는 이러한 작업을 쉽게 수행할 수 있도록 도와줍니다.

더 자세한 내용은 Express.js 공식 문서를 참고하시기 바랍니다.