TIL) Node.js - REST API

oatraspberry·2023년 1월 1일
post-thumbnail

API

Application Programming Interface
서로 다른 프로그램간에 소통할 수 있게 도와주는 통신 규약
서버에게 요청해서 데이터를 가져오는 방법

.get('/') -> API

REST API

REST 원칙 6개
1) Uniform interface 중요

  • 하나의 자료는 하나의 URL로
  • URL 하나를 알면 둘을 알 수 있어야 한다
  • 요청과 응답은 정보가 충분히 들어있어야 한다

2) Client- Server 역할 구분

  • 브라우저는 요청만 하고, 서버는 응답만 해야 한다.

3) Stateless

  • 요청1과 요청2는 의존성이 없어야 한다.

4) Cacheable

  • 서버에서 보내주는 정보들은 캐싱이 가능해야 한다.
  • 캐싱을 위한 버전 같은 것도 관리 잘해야 한다.

5) Layered System

  • 여러개의 레이어를 거쳐서 요청을 처리하게 만들어도 된다.

6) Code on Demand

  • 서버는 고객에게 실제 실행가능한 코드를 전송해줄 수도 있다.

URL 이름짓기 관습

  • 동사보다는 명사 위주로 작성하기.
  • 응용해서 다른 정보들을 쉽게 가져올 수 있을 정도로 일관성 있게 작성하기.
  • 대충 봐도 어떤 정보가 들어올지 예측이 가능하게 작성하기.
  • 띄어쓰기는 _ 대신 - 기호 사용
  • 파일 확장자 쓰지 않기 (.html 등)
  • 하위 문서들을 뜻할 땐 / 기호를 사용하기.

출처: 코딩애플 강의

profile
개발자가 될테야

0개의 댓글