REST API

최근 REST API를 개발하는 프로젝트를 진행하고 있었다. Controller 코드를 작성하며 URI를 어떻게 설정할지에 대해 고민을 하는 나의 모습을 보며 REST API에 대한 개념이 부족하다는 것을 느끼게 되었다. 그래서 REST API의 개념을 확실히 잡고자 본 글을 포스팅하게 되었다.

 

 API

먼저 REST API를 말하기 전에 API가 무엇인지 짚고 넘어가보자.

API(Application Programming Interface)란 소프트웨어간 통신할 수 있게 하는 매커니즘이다. 예를들어 날씨 어플을 사용 한다면 날씨 어플은 기상청 소프트웨어에서 제공하는 API를 통해 기상청의 날씨 정보를 얻을 수 있다.

 

REST

다음으로 REST에 대해서 알아보자.

Representational State Transfer의 약어로 REST란 네트워크에서 자원을 이름으로 구분짓고 자원의 상태를 주고받는 모든 것을 의미한다. 

• 즉, 자원(resource)의 이름(representation) 에 의한 상태 전달
  자원: 해당 소프트웨어가 관리하는 모든 것
  -> Ex) 문서, 그림, 데이터, 해당 소프트웨어 자체 등
  
  
• 자원의 이름: 그 자원을 표현하기 위한 이름
  -> Ex) DB의 학생 정보가 자원일 때, ‘students’를 자원의 이름으로 정한다.
  
  
• 상태 전달
  데이터가 요청되어지는 시점에서 자원의 상태(정보)를 전달한다.
  JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.

구체적인 개념

구체적으로 정의하자면 HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미한다.

• CREATE(POST)
• READ(GET)
• UPDATE(PUT)
• DELETE(DELETE)

URI

URI가 나온 김에 URI, URL, URN의 개념도 함께 짚고 넘어가보자

 

URI: 웹 사이트의 이미지, 텍스트, DB 내용 등의 모든 자원의 고유한 ID

 

URL: 리소스가 있는 위치

URL은 다음과 같은 구조로 이루어져 있다.

https://www.example.com:443/search?q=hello/#fragment 

프로토콜(https) + 호스트명(www.example.com) + 포트번호(443)(생략 가능)  + 경로(/search) + 쿼리 파라미터(q=hello) + fragment(생략 가능)

여기서 fragment란 리소스 자체의 다른 부분을 가르키는 문자열이다. 예를 들어 fragment를 특정 이미지로 지정 한다면 해당 페이지에서 스크롤을 내릴 필요 없이 바로 그 이미지가 있는 화면으로 이동하게 된다.

 

URN: 리소스에 이름을 부여

 

 

예를들어 어떠한 리소스가 있다. 이 리소스에 A라는 URN을 부여했다고 생각하자. A라는 리소스는 다음의 URL에 있을 때 www.joyfulviper.tistory.com  해당 url을 통해 A에 접근 할 수 있다. 하지만 url을 변경하게 된다면 위의 url로는 A에 접근할 수 없게 된다. 이럴때 URN을 통해 리소스에 이름을 부여하게 된다면 url이 아무리 변경하더라도 A자체의 이름(URN)으로 접근할 수 있다. URL과 URN 모두 URI를 표현하는 방식이라고 볼 수 있는 것이다.

 

REST의 장점과 단점

• HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구출할 필요가 없다.
• HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해준다.
• HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
• REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.
• 여러가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다.
• 서버와 클라이언트의 역할을 명확하게 분리한다.
• 표준이 존재하지 않는다.
• HTTP Method 형태가 제한적이다.

REST의 필요성

최근 서버 프로그램은 다양한 브라우저와 안드로이드폰, 아이폰과 같은 모바일 디바이스에서도 통신을 할 수 있어야 한다. 

이러한 다양한 클라이언트에 대한 지원을 위해 REST에 대한 관심이 커지게 되었다.

 

REST의 구성요소

• 자원(URI)
  서버에는 자원이 존재하고 클라이언트는 URI를 통해 자원에 접근하여 서버에 요청을 한다.
• 행위(METHOD)
  HTTP의 메소드를 통해 자원에 대한 행위를 한다 (GET, POST, PUT, DELETE)
• 표현(Represention of Resource)
  클라이언트가 자원의에 대한 조작을 요청하면 서버는 이에 적절한 응답을 한다.
  REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 표현으로 나타내어 질 수 있다.
  JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.

 

REST의 특징

• Server-Client(서버-클라이언트 구조)
  자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 된다.
  REST Server: API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다.
  Client: 자원에 대한 요청을 한다.
  
  
• Stateless(무상태)
  HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 갖는다.
  즉, 클라이언트의 요청을 서버에 저장하지 않는다. Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리하여 서버의 처리 방식에 일관성을 부여하고 서비스의 자유도가 높아진다.
  
  
• Cacheable(캐시 처리 가능)
  웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다.
  즉, HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있다.
  HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.
  대량의 요청을 효율적으로 처리하기 위해 캐시가 요구된다.
  즉, 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있다.
  
  
• Layered System(계층화)
  Client는 REST API Server만 호출한다.
  REST Server는 다중 계층으로 구성될 수 있다.
  API Server는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의 유연성을 줄 수 있다.
  또한 로드밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상시킬 수 있다.
  PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있다.
  
  
• Code-On-Demand(optional)
  Server로부터 스크립트를 받아서 Client에서 실행한다.
  반드시 충족할 필요는 없다.
  
  
• Uniform Interface(인터페이스 일관성)
  URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다. 따라서 특정 언어나 기술에 종속되지 않고 HTTP 표준 프로토콜을 따르는 모든 플랫폼에서 사용이 가능하다.

REST API

위에서 REST가 뭔지도 봤고, API가 뭔지도 봤다. REST API는 REST를 기반으로 구현한 API를 의미한다.

 

REST API 설계 기본 규칙

도큐먼트 : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념
컬렉션 : 서버에서 관리하는 디렉터리라는 리소스
스토어 : 클라이언트에서 관리하는 리소스 저장소

 

1. URI는 정보의 자원을 표현해야 한다.
resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다.
resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다.
resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다.
resource의 스토어 이름으로는 복수 명사를 사용해야 한다

예) GET /member/1 -> GET /members/1

 

2. 자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현한다.

URI에 동사가 들어가면 안된다. 즉, CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.

예) DELETE /members/remove/1 -> DELETE /members/1

 

경로 부분중 변하는 부분은 유일한 값(id)으로 대체한다.

에) Delete /members/1

 

REST API 설계 규칙

• 슬래시 구분자(/ )는 계층 관계를 나타내는데 사용한다.
  Ex) http://restapi.example.com/houses/apartments
  
  
• URI 마지막 문자로 슬래시(/ )를 포함하지 않는다.
  URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 한다. 따라서 분명한 URI를 만들어 URI의 마지막에는 슬래시를 사용하지 않아야 한다.
  Ex) http://restapi.example.com/houses/apartments/ (X)
  
  
• 하이픈(- )은 URI 가독성을 높이는데 사용
  불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.
  
  
• 밑줄(_ )은 URI에 사용하지 않는다.
  밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않는다.
  
  
• URI 경로에는 소문자가 적합하다.
  URI 경로에 대문자 사용은 피하도록 한다.
  RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문
  
  
• 파일확장자는 URI에 포함하지 않는다.
  REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.
  Accept header를 사용한다.
  Ex) http://restapi.example.com/members/soccer/345/photo.jpg (X)
  Ex) GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg (O)
  
  
• 리소스 간에는 연관 관계가 있는 경우
  /리소스명/리소스 ID/관계가 있는 다른 리소스명
  Ex) GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

예시

CRUD	HTTP METHOD	REOUTE
리소스 전체 조회	GET	/resource
리소스 하나 조회	GET	/resource/{id}
리소스 생성	POST	/resource
리소스 수정	PUT	/resource/{id}
리소스 삭제	DELETE	/resource/{id}

 

RESTful

위의 REST API의 규칙과, REST의 특징을 잘 나타내도록 설계한 API를 RESTful한 API라고 한다.

 

 

REFERNCE

https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html