REST API - MoonGyeongHyeon/Keyword_Study GitHub Wiki

REST API

REST는 REpresentational State Transfer의 약자로 2000년도에 로이 필딩에 의해 처음 소개됐다. 로이 필딩은 HTTP의 주요 저자 중 한 사람으로, 당시 HTTP 설계의 우수성에 비해 제대로 사용되어지지 못하는 모습에 안타까워하여 웹의 장점을 최대한 활용할 수 있는 아키텍쳐로 REST를 발표했다.

REST의 구성

• 자원 - URI
• 행위 - HTTP Method
• 표현 (Representation)

REST의 특징

• Uniform (유니폼 인터페이스)
  • URI로 지정한 자원에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍쳐 스타일.
• Stateless
  • REST는 무상태성 성격을 갖는다. 다시 말해, 작업을 위한 상태정보를 따로 저장/관리하지 않는다. 세션 정보나 쿠키 정보를 별도로 저장/관리하지 않기 때문에 API 서버는 들어오는 요청만 단순히 처리하면 된다. 때문에, 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해진다.
• Cacheable
  • REST의 가장 큰 특징 중 하나는 HTTP라는 기존 웹 표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용할 수 있다. 따라서 HTTP가 가진 캐싱 기능을 적용할 수 있다. HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.
• Self-descriptiveness (자체 표현 구조)
  • REST API 메세지만 보고도 어떤 의미인지 쉽게 이해할 수 있는 자체 표현 구조로 이루어져 있다.
• Client-Server 구조
  • REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보) 등을 직접 관리하는 구조로, 각각의 역할이 확실히 구분되어 있기 때문에 클라이언트와 서버에서 개발할 내용이 명확해지고 서로의 의존성이 줄어들게 된다.
• 계층형 구조
  • REST 서버는 다중 계층으로 구성될 수 있으며 보안, LB, 암호화 계층을 추가해 구조 상의 유연성을 둘 수 있고 proxy, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있게 한다.

REST API 가이드

REST API 설계 시 다음 2가지 항목이 정말 중요하다.

1. URI는 정보의 자원을 표현한다.
2. 자원에 대한 행위는 HTTP Method로 표현한다.

REST API 중심 규칙

URI는 정보의 자원을 표현해야 한다. (자원명은 동사보다는 명사를 사용)

GET /members/delete/1

위와 같은 방식은 REST를 제대로 적용하지 않은 URI이다. URI는 자원을 표현하는 데 중점을 두어야 한다. delete와 같은 행위에 대한 표현이 들어가선 안된다.

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

위의 잘못된 URI를 HTTP Method로 수정하여 표현하면 아래와 같이 수정할 수 있다.

DELETE /members/1

회원정보를 가져올 때는 GET, 회원을 추가할 때는 POST를 사용하여 표현한다.

회원정보를 가져오는 URI

GET /members/show/1     (x)
GET /members/1          (o)

회원을 추가할 때 URI

GET /members/insert/2 (x)  - GET 메서드는 자원 생성에 맞지 않습니다.
POST /members/2       (o)

POST, GET, PUT, DELETE 4가지의 Method를 사용해 CRUD를 구현할 수 있다.

METHOD	역할
POST	POST를 통해 해당 URI를 요청하면 자원을 생성합니다.
GET	GET를 통해 해당 자원을 조회합니다. 자원을 조회하고 해당 도큐먼트에 대한 자세한 정보를 가져온다.
PUT	PUT를 통해 해당 자원을 수정합니다.
DELETE	DELETE를 통해 자원을 삭제합니다.

위와 같은 식으로 URI는 자원을 표현하는 데 집중하고, 행위에 대한 정의는 HTTP Method를 통해 하는 것이 REST API 설계의 중심 규칙이다.

URI 설계 시 주의사항

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

  http://restapi.example.com/houses/apartments
  http://restapi.example.com/animals/mammals/whales
  

• URI 마지막 문자로 슬래시를 포함하지 않는다.

  URI에 포함되는 모든 글자는 자원의 유일한 식별자로 사용되어야 하며, URI가 다르다는 것은 자원이 다르다는 것이고, 역으로 자원이 다르면 URI도 달라야 한다. REST API는 분명한 URI를 만들어 통신을 해야하기 때문에 혼동을 주지 않도록 URI의 마지막에는 슬래시를 사용하지 않는다.

  http://restapi.example.com/houses/apartments/ (X)
  http://restapi.example.com/houses/apartments  (0)
  

• 하이픈(-)은 URI 가독성을 높이는 데 사용한다.

  URI를 쉽게 읽고 해석하기 위해 불가피하게 긴 URI 경로를 사용하게 된다면 하이픈을 사용해 가독성을 높일 수 있다.

• 밑줄(_)은 사용하지 않는다.

  글꼴에 따라 밑줄이 보기 힘들거나 보이지 않거나 밑줄 때문에 문자가 가려지기도 한다. 이런 문제를 피하기 위해 밑줄 대신 하이픈을 사용하자.

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

  URI 경로에 대문자 사용은 피하도록 한다. 대소문자에 따라 다른 리소스로 인식하기 때문이다.

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

  http://restapi.example.com/members/soccer/345/photo.jpg (X)
  

  REST API에서는 메세지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI에 포함시키지 않는다. Accept Header 를 사용하도록 하자.

  GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg
  

자원 간의 관계를 표현하는 방법

REST 자원 간에는 연관 관계가 있을 수 있다. 이럴 땐 아래와 같은 방법으로 표현한다.

/리소스명/리소스 ID/관계가 있는 다른 리소스명

ex)    GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

만약 관계명이 복잡하다면 이를 서브 자원에 명시적으로 표현하는 방법이 있다. 예를 들어, 사용자가 좋아하는 디바이스 목록을 표현해야 하는 경우, 다음과 같은 형태로 사용될 수 있다.

GET : /users/{userid}/likes/devices (관계명이 애매하거나 구체적 표현이 필요할 때)

자원을 표현하는 Collection과 Document

Collection과 Document에 대해 알면 URI 설계가 한 층 더 쉬워진다. Document는 단순히 문서로 이해해도 되고, 하나의 객체라고 이해해도 된다. Collection은 문서들의 집합, 객체들의 집합이라 생각하면 된다. Collection과 Document는 모두 자원이라고 표현할 수 있으며 URI에 표현된다.

http:// restapi.example.com/sports/soccer

위 URI는 sports라는 Collection과 soccer라는 Document로 표현되고 있다고 생각하면 된다.

http:// restapi.example.com/sports/soccer/players/13

sports, players Collection과 13(13번 선수)을 의미하는 Document로 URI가 이루어지게 된다. 여기서 중요한 점은 Collection은 복수로 사용하고 있다는 것이다. 직관적인 REST API를 위해선 Collection과 Document를 사용할 때 단수 복수를 지켜준다면 좀 더 이해하기 쉬운 URI를 설계할 수 있다.