REST / HTTP

14 Oct 2021 - 2 minute read

REST

---

• Representational State Transfer

• 데이터가 요청되어지는 시점에서 자원의 상태(정보)를 전달

• JSON 혹은 XML을 통해 데이터를 주고 받는 것이 일반적

• • Client, Server : 클라이언트와 서버가 서로 독립적으로 분리 되어 있어야 함

  • Stateless : 요청에 대해 클라이언트의 상태를 서버에 저장하지 않아야 함

  • Cache : 클라이언트는 서버의 응답을 Cache(임시저장)할 수 있어야 함 / 클라이언트가 Cache를 통해서 응답을 재사용할 수 있어야 하며, 이를 통해서 서버의 부하를 낮춤

  • Layered System(계층화) : 서버와 클라이언트 사이에 방화벽, 게이트웨이, Proxy 등 다양한 계층 형태로 구성이 가능해야 하며, 이를 확장 할 수 있어야 함

  • 인터페이스 일관성 : 인터페이스의 일관성을 지키고, 아키텍처를 단순화시켜 작은 단위로 분리하여, 클라이언트, 서버가 독립적으로 개선될 수 있어야 함

  • Code on Demand (optional) : 자바스크립트 등 특정한 기능을 서버로부터 클라이언트가 전달받아 코드를 실행할 수 있어야 함

인터페이스 일관성 - REST를 잘 사용했는지 판단하기

• 아래 조건들을 잘 갖춘 경우 Restful 하다고 표현, 이를 REST API라고 부름

• 자원의 식별

  • 웹 기반의 REST에서는 리소스 접근을 할 때 URI 사용

    • https://abcd.co.kr/user/100

      • Resource : user

      • 식별자 : 100

• 메시지를 통한 리소스 조작

  • Web에서는 HTML, XML, JSON, TEXT 등 다양한 방식으로 데이터 전달

  • 어떠한 타입의 데이터인지를 알려주기 위해 HTTP Header 부분에 content-type을 통해 데이터 타입 지정할 수 있음

  • 리소스 조작을 위해 데이터 전체 전달 X, 메시지로 전달

• 자기 서술적 메시지

  • 요청하는 데이터가 어떻게 처리 되어져야 하는지 충분한 데이터를 포함 할 수 있어야 함

  • HTTP 기반의 REST 에서는 HTTP Method와 Header 정보, URI에 포함되는 정보로 표현 가능

• Application 상태에 대한 엔진으로써 하이퍼미디어

  • REST API를 개발할 때 단순히 Client 요청에 대한 데이터만 응답 해주는 것이 아닌 관련된 리소스에 대한 Link 정보까지 같이 포함 되어져야 함

---

HTTP 요청 메서드

• 동일한 요청을 한 번 보내는 것과 여러 번 연속으로 보내는 것이 같은 효과를 지니고, 서버의 상태도 동일하게 남을 때, 해당 HTTP 메서드가 멱등성을 가졌다고 한다

• GET : 사용자의 정보 요청

• POST : 사용자 정보 생성

• PUT : 사용자 정보 생성 및 수정

• DELETE : 사용자 정보 삭제

HTTP Status Code

• 응답의 상태를 나타내는 코드

  • 1XX

    • 의미 : 처리중

    • 처리가 계속 되고 있는 상태, 클라이언트는 요청을 계속 하거나 서버의 지시에 따라 재요청

  • 2XX

    • 의미 : 성공

    • 요청의 성공

  • 3XX

    • 의미 : 리다이렉트

    • 다른 리소스로 리다이렉트, 해당 코드를 받았을 때는 Response의 새로운 주소로 다시 요청

  • 4XX

    • 의미 : 클라이언트 에러

    • 클라이언트의 요청에 에러가 있는 상태, 재전송 해도 에러가 해결되지 않음

  • 5XX

    • 의미 : 서버에러

    • 서버 처리 중 에러가 발생한 상태, 재 전송시 에러가 해결 되었을 수도 있음

• 자주 사용되는 코드들

  • 200 : 성공

  • 201 : 성공, 리소스 생성 성공

  • 301 : 리다이렉트, 리소스가 다른 장소로 변경됨을 알림

  • 303 : 리다이렉트, Client에서 자동으로 새로운 리소스로 요청 처리

  • 400 : 요청 오류, 파라미터 에러

  • 401 : 권한 없음 (인증실패)

  • 404 : 리소스 없음 (페이지를 찾을 수 없음)

  • 500 : 서버 내부 에러 (서버 동작 처리 에러)

  • 503 : 서비서 정지 (점검 등)