TIL. 49 RESTful API ?

📄 REST 개념 정리

• "Restful한 설계". 무슨 뜻일까?

• REST는 아키텍처 원칙 세트이다. 요청이 수행될 때, REST API는 리소스 상태에 대한 표현을 요청자에게 전송한다.

• HTTP URI를 통해 자원(Resource)을 명시하고, HTTP Method인 POST GET PUT DELETE를 통해 해당 자원에 대한 CRUD 작업을 적용한다.

  • POST Create(요청하면 자원을 생성)
  • GET Read(자원을 조회)
  • PUT Update(자원을 수정)
  • DELETE Delete(자원을 삭제)

• REST는 자원 기반으로 설계되며 HTTP Method를 통해 자원을 처리하는 아키텍처를 의미한다고 볼 수 있다.

• RESTful 일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내며 특정 기술을 정의하는 것이 아니다. REST API를 제공하는 웹 서비스를 RESTful하다고 할 수 있다.

REST를 따르는 이유?

• REST API는 쉽게 세가지로 구분할 수 있다.

  • 자원(Resource) URI
  • 행위(Verb) HTTP Method
  • 표현(Representations)

• HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용 가능하다.

• 자원의 표현뿐만 아니라 그 행위(HTTP Method)와 해당 자원의 응답 상태코드가 상황을 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.

• Client-Server 구조 서버는 API 제공, 클라이언트는 사용자 인증이나 콘텍스트(세션, 로그인 정보) 등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 서로간의 개발해야 할 내용이 명확해지고 의존성이 줄어든다.

• Uniform Interface(유니폼 인터페이스) URI로 지정한 자원에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일을 말한다.

• Stateless(무상태성) REST는 무상태성 성격을 갖는다. 세션 정보나 쿠키 정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 요청만 단순 처리하면 된다. 이로 인해 서비스 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않으므로써 구현이 단순해진다.

• Cacheable(캐시) 가장 큰 특징 중 하나는 HTTP라는 기존 웹표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용할 수 있다. 따라서 HTTP가 가진 캐싱 기능이 적용 가능하다. HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.

• Self-Descriptiveness(자체 표현 구조) REST API 메시지만 보고도 이를 쉽게 이해할 수 있는 자체 표현 구조로 되어 있다.

REST API의 사용

• URI는 자원 자체를 표현해야 한다.

• 자원에 대한 행위는 HTTP Method로 표현한다.

  ex ) 삭제
  -- GET /students/delete/1 (X)
  -- DELETE /students/1 (O)

  ex ) 조회
  -- GET /students/show/1 (X)
  -- GET /students/1 (O)

  ex ) 생성
  GET /students/insert/2 (X)
  POST /students/2 (O)

• 슬래시 구분자(/)는 계층 관계를 나타내는 데 사용한다.

• 불가피하게 긴 URI 경로를 사용하게 된다면 하이픈(-)을 사용해 가독성을 높일 수 있다.

• URI 문법 형식(RFC 3986)은 대소문자를 구분하기 때문에 혼란을 막기 위해 소문자 형태를 선호한다.

• 직관적인 REST API를 위해 컬렉션(자원의 모음)과 도큐먼트(자원)를 사용할 때 단수, 복수 표현을 지키면 좋다.

💬💬💬

REST와 RESTful이라는 말을 자주 사용한다. 나는 REST API를 적용하고 있다고 막연히 생각했고, 이는 실제로 디테일한 내용은 모른채 대략적인 개념만 알고 작업을 하게 되는 문제로 이어졌다. 하지만 문제가 있으므로 좀 더 학습할 수 있는 계기가 되어 하나의 지식을 습득할 수 있었다고 생각한다.