Rest API

  • REST란
    • 2000년도에 로이 필딩의 박사 학위 논문에서 소개
    • REpresentational State Transfer : 표현 상태 전달 → 자원의 표현을 가지고 상태를 전달한다.
      • 자원의 표현 : HTTP URI
      • 상태 전달 : HTTP Method
  • REST의 특징
    1. Uniform(유니폼 인터페이스)
      • Uniform Interface는 URI로 지정한 자원에 대한 조작을 한정적인 인터페이스로 수행하는 아키텍처 스타일을 말한다.
    2. Stateless(무상태성)
      • 작업을 위한 상태 정보를 따로 저장하거나 관리하지 않는다.
      • 세션 정보나 쿠키정보를 별도로 저장하지 않기 때문에 API서버는 들어오는 요청만 처리하면 된다.
      • 서비스의 자유도가 높아지고 구현이 단순해진다.
    3. Cacheable(캐시 가능)
      • HTTP 웹 표준을 사용하기 때문에 HTTP가 가진 캐싱 기능을 적용할 수 있다.
    4. Self-descriptivenss(자체 표현 구조)
      • REST API 표현만 보고 쉽게 이해할 수 있는 구조이다.
    5. Client - Server 구조
      • 서버와 클라이언트의 역할이 구분되기 때문에 개발 내용이 명확해지고 서로 간의 의존성이 줄어든다.
    6. 계층형 구조
      • REST 서버는 다중 계층으로 구성될 수 있다.
      • 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있다.
  • REST API 설계 규칙
    1. URI는 정보의 자원을 표현해야 한다.
    2. 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현한다.
Method 역할
GET 해당 리소스를 조회
POST 리소스를 생성
PUT 해당 리소스를 수정
DELETE 리소스를 삭제

​

  • REST API 설계시 URI 규칙
  1. 슬래시 구분자 ( ‘ / ‘ ) 는 계층 관계를 나타낸다.
   GET http://www.chichi.com/users/school/uos

해당 사이트에서 ‘uos’ 의 정보를 가지고 있는 유저들을 찾을때 다음과 같이 계층형으로 표현되는 것을 볼 수 있다.

  1. 리소스명은 동사보다 명사를 사용한다.

    GET http://www.chichi.com/users/show/1  (X)
GET http://www.chichi.com/users/1       (O)

  2. 언더바( ‘_’ ) 보다는 하이픈( ‘ - ‘ )을 권장한다.

    GET http://www.chichi.com/food-calory

  3. URI 경로에는 소문자가 적합하다.

  4. 파일 확장자는 URI에 포함시키지 않는다.

    GET http://www.chichi.com/users/1/photo.jpg  (X)

    대신에 Accept header를 사용한다.

    GET http://www.chichi.com/users/1/photo HTTP/1.1 Host: www.chichi.com Accept: image/jpg
  • 응답 상태 코드
    • 2XX (성공) : 이 작업을 성공적으로 받아들여졌다는 의미
      • 200 OK
    • 3XX (리다이렉션) : 이 요청을 완료하기 위해서는 리다이렉션이 이루어져야 한다는 의미
      • 301 : 클라이언트가 요청한 리소스에 대한 URI가 변경되었을 때
    • 4XX (클라이언트 오류) : 이 요청은 올바르지 않다는 의미
      • 400 Bad Request : 클라이언트 요청이 부적절할 경우
      • 401 Unauthorized : 클라이언트가 인증되지 않은 상태에서 보호된 리소르르 요청했을 때
      • 403 Forbidden : 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때
      • 404 Not Found : 찾는 리소스가 없을 때
      • 405 Method Not Allowed : PUT이나 DELETE 등 서버에서 허용되지 않은 메소드로 요청했을 때
    • 5XX (서버 오류) : 올바른 요청에 대해 서버가 응답할 수 없다는 의미
      • 500 Internal Server Error : 서버에 오류가 발생해 작업을 수행할 수 없을 때
  • REST API 장점
    • 언어와 플랫폼에 독립적이다.
    • 다른 통신방식(SOAP) 보다 개발이 쉽고 단순하다.
    • HTTP를 사용하기 때문에 기존 웹 인프라를 사용가능하다.
  • REST API 단점
    • HTTP 프로토콜만 사용가능하다.
    • p2p 통신 모델을 가정했기 때문에 둘 이상을 대상으로 하는 분산 환경에 유용하지 않다.
    • 보안,정책에 대한 표준이 없다.