[week_06] Express.js와 REST API | Middleware, JSON, Postman

1. Middleware

1-1. Express.js의 Middleware

• HTTP 요청과 응답 사이에서 단계별 동작을 수행해주는 함수
• HTTP 요청과 응답 객체를 처리하거나, 다음 미들웨어 실행
• HTTP 요청이 들어온 순간 시작 ➡ HTTP 응답 마무리될 때 까지 미들웨어 동작 사이클 실행

1-2. Middleware 작성법

• req, res, next를 가진 함수를 작성
• req: HTTP 요청을 처리하는 객체
• res: HTTP 응답을 처리하는 객체
• next: 다음 미들웨어를 실행하는 함수

const logger = (req, res, next) => {
	console.log(`Request ${req.path}`);
    next();
}

• next() 함수가 호출되지 않으면 미들웨어 사이클이 멈추기 때문에 주의

1-3. Middleware 사용법

• 적용되는 위치에 따라: 어플리케이션 / 라우터 / 오류처리 미들웨어로 분류 가능

1) 어플리케이션 미들웨어

• 미들웨어 작성 후 app 객체의 use를 통해 연결하거나,
• app 객체의 HTTP method 함수를 통해 연결
• 미들웨어를 모든 요청에 공통적으로 적용하기 위한 방법
• HTTP 요청이 들어온 순간부터 적용된 순서대로 동작

2) 라우터 미들웨어

• 미들웨어가 router 객체에 적용되는 것
• 특정 경로의 라우팅에만 미들웨어를 적용하기 위한 방법
• app 객체에 라우터가 적용된 이후로 순서대로 동작

3) 미들웨어 서브스택

• use 나 HTTP method 함수에 여러 개의 미들웨어를 동시에 적용
• 주로 한 개의 경로에 특정해서 미들웨어를 적용하기 위해 사용
• 전달된 인자의 순서 순으로 동작

4) 오류처리 미들웨어

• 일반적으로 가장 마지막에 위치하는 미들웨어
• err, req, res, next 네 가지 인자를 가진다.
• 앞선 미들웨어에서 next 함수에 인자가 전달되면 실행됨
  • 이전에 적용된 미들웨어 중, next에 인자를 넘기는 경우 중간 미들웨어들은 뛰어넘고 오류처리 미들웨어가 바로 실행된다.

5) 함수형 미들웨어

• 하나의 미들웨어를 작성하고, 작동 모드를 선택하면서 사용하고 싶을 경우
• ex) API 별로 사용자의 권한을 다르게 제한하고 싶은 경우

 

2. REST API

• REST 아키텍쳐를 준수하는 웹 API
• API: 서비스나 프로그램 간에 미리 정해진 기능을 실행할 수 있도록 하는 규약
• REST: 웹에서 자료를 전송하기 위한 표현 방법에 대한 아키텍쳐

2-1. REST API 기본 가이드 - HTTP Method의 사용

• REST API는 API의 동작을 HTTP method + 명사형 URL로 표현
• ex) /posts라는 URL이 '게시글'이라는 자원을 가리킬 때, GET/POST/PUT/DELETE의 HTTP method와 결합하여 API 동작 정의

2-2. REST API 기본 가이드 - URL 표현법

• REST API URL의 자원은 복수형으로 표현
• 하나의 자원에 대한 접근 => 복수형 + 아이디
• ex) /posts/1

2-3. REST API 기본 가이드 - 계층적 자원

• REST API는 URL을 통해 자원을 계층적으로 표현
• ex) /users/1/posts = 1번 유저의 게시글 전체

REST API에 대한 보다 자세한 내용은 여기에 정리해 두었다.

 

3. JSON

• 웹 API에서 데이터를 전송할 때 표현식으로 주로 사용
• 어떤 객체를 웹 API를 통해 문자열로 전달하기 위해 JSON을 사용
• Object => { "key" : value } 로 표현
• Array => [ item1, item2 ] 로 표현

 

4. Express.js.로 REST API 구현하기

🔹 데이터베이스 없이 Node.js 모듈 활용
🔹 간단한 메모의 작성, 수정, 삭제, 확인기능 API 구현
🔹 express-generator를 사용하지 않고 MVC 패턴 구현

4-1. MVC 패턴

• Model - View - Controller
• 프로젝트의 기능들을 어떻게 분리할지에 대한 하나의 구성 방법

1) Model

• 데이터에 접근하는 기능 또는 데이터 그 자체
• 데이터의 읽기, 쓰기는 Model을 통해서만 이루어지도록 구성

2) View

• 데이터를 표현하는 기능
• Controller에 의해 데이터를 전달받고, 화면에 표시해주는 기능

3) Controller

• Model을 통해 데이터에 접근해서 처리 결과를 View로 전달하는 기능
• 웹 서비스에서는 주로 라우팅 함수가 해당 기능 수행

4-2. 프로젝트 구현 사항

• JavaScript의 Array 함수 사용하여 데이터 처리 구현
• router와 route handler를 사용하여 HTTP 요청, 응답 처리 구현
• 오류처리 미들웨어를 사용하여, 오류를 처리하는 방법 구현
• 정의되지 않은 라우팅에 대해 404 오류 처리 구현

 

5. Postman

• API를 테스트할 수 있는 도구
• HTTP 요청을 손쉽게 작성하여 테스트할 수 있음
• API를 문서화 할 수 있는 기능 및 다양한 도구 제공

5-1. Postman으로 API 문서화하기

• collection만들기
• api request 만들기
• document 작성하기
• 전체 문서 확인하기

5-2. Postman으로 API 테스트하기

• HTTP Method 설정하기
• query param 사용하기
• path variable 사용하기
• body 사용하기