Express

Express란

Node.js에서 가장 많이 사용되는 서버 프레임워크

// app.ts
import express from 'express';

const port = 3000;

const app = express(); // App 서버 인스턴스 생성

app.get('/', (req, res) => {
  res.send('Hello, World@@');
});
 // listen -> 지정한 포트로 클라이언트 접속을 받아주겠다 선언! 
app.listen(port, () => {
  console.log(`Server running at http://localhost: ${port}`);
});

URL 구조

URL 주소가 localhost:3000인 경우, 일반적으로 URL 앞에 http(s)://를 붙이고, URL 뒤에 경로 /를 붙인다. 따라서, 이 경우의 URL full path는 'https://localhost:3000/'가 된다.

하지만, /를 생략하는 경우에도 대부분의 브라우저는 동일한 페이지를 참조한다.

ts-node

Typescript REPL

타입스크립트로 작성된 코드를 컴파일 과정 없이 바로 실행해주는 도구

npx ts-node app.ts

nodemon

서버 측 코드 변경사항이 생기면 자동으로 서버를 재실행 해주는 도구

npx nodemon app.ts

nodemon를 사용하는 이유

서버는 실행 시점에 코드를 사용하여 동작하기 때문에 실시간 코드 변경사항이 적용되지 않는다.

변경사항을 적용하려면 서버를 재실행 해야함

이런 귀찮은 작업을 nodemon 이 해결해준다.

ts-node 에 의존성을 갖고있기 때문에 꼭 같이 설치가 되있어야 한다.

res.send

클라이언트가 받을 JSON 형식의 데이터를 전송

자바스크립트 객체를 넣으면 자동으로 JSON 개체로 변환된다.

app.get('products', (req, res) => {
  const products = [...];
  res.send({products, page: {currentPage: 1, totalPage: 10 })
})

전송될 데이터 확인하는 방법

1. 브라우저로 직접 url을 입력해서 확인

2. 터미널 상에서 확인 (curl, http)

curl로 확인

curl localhost:3000/proudcts

HTTPie로 확인

HTTP 명세와 데이터를 더 자세하게 확인할 수 있다.

http localhost:3000/products

REST API

"어떻게 하면 기존에 HTTP로 구축되어 있던 웹들과 호환성의 문제가 생기지 않게 개발할 수 있을까"

- Roy T. fielding

REpresentational State Transfer, 웹 기반 시스템에서 클라이언트와 서버간의 통신을 위한 아키텍처 스타일

클라이언트와 서버 간의 통신을 단순하고 효율적으로 만들며, 다양한 플랫폼과 언어에 호환되는 유연하고 확장 가능한 웹 API를 제공한다.

REST API 특징

• 클라이언트와 서버 간 통신에 HTTP 프로토콜을 사용

• 자원을 URI로 표현

• HTTP Method를 통해 자원을 처리

Roy T. fielding이 제시한 REST API 제약 조건 4가지

RESTful API -> REST 아키텍쳐 스타일을 따르는 API

• 리소스 식별: 리소스가 URI로 식별되야 함

• 표현을 통한 리소스 제어: 표현을 통해서 자원을 조작해야 한다.

• 셀프 설명 메시지: 스스로 설명하는 메시지가 되어야 한다.

• HATEOAS: 애플리케이션 상태가 하이퍼미디어를 통해 전이되어야 한다.

보통 REST API에서는 엔드포인트(URI)를 통해 자원을 명시하고, HTTP Verb(Method)를 대입하여 자원을 어떻게 처리할지를 정한다.

대부분 4가지를 모두 만족하지 않고 Resource와 HTTP Verb만 도입하는 수준으로 사용됨

제약조건을 모두 만족하지 않아도 REST 아키텍처가 제공하는 일부 개념과 원칙을 따르기 때문에 그냥 통용적으로 REST API라 부르게 됨

HTTP Verb(Method)

클라이언트가 서버에 요청을 보낼 때 자원을 어떻게 처리할 것인지 나타내는 방법

리소스 URL: /products

1. Read (Collection) -> GET /products * Read는 Collection과 Item(Element)로 나뉨

2. Read (Item) -> GET /products/{id}

3. Create (Collection Pattern 활용) -> POST /products

4. Update (Item) -> PUT 또는 PATCH /products/{id}

5. Delete (Item) =-> DELETE /products/{id}

Collection Pattern in REST API

Collection Pattern은 HTTP Verb와 함께 사용되며 자원을 다루는 방법을 일관성 있게 정의하여 API의 가독성과 사용성을 크게 향상시킨다.