[네트워크] REST API와 RESTful

REST란

Representational State Transfer로 자원을 이름으로 구분하여 해당 자원의 상태를 주고받는 모든 것을 의미한다.

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

 

 

REST의 구성

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

 

 

REST의 특징

1.  Server-Client(서버-클라이언트 구조)
   REST Server: API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다.
   Client: 사용자 인증이나 컨텍스트(세션, 로그인 정보) 등을 직접 관리하고 책임진다.
   개발 내용이 명확히 구분되고 서로 간 의존성이 줄어든다.
   
   
2. Stateless(무상태)
   HTTP 프로토콜은 Stateless Protocol이므로 무상태성을 갖는다. Client의 context를 Server에 저장하지 않는다.
   즉, 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 되므로 구현이 단순해진다.
   Server의 처리 방식에 일관성을 부여하고 부담이 줄어들며, 서비스의 자유도가 높아진다.
   
   
3. Cacheable(캐시 처리 가능)
   HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.
   캐시 사용을 통해 응답시간이 빨라지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있다.
   
   
4. Layered System(계층화)
   REST Server는 다중 계층으로 구성될 수 있다.
   로드밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상시킬 수 있으며 PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있다.
   
   
5. Uniform Interface(인터페이스 일관성)
   URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.

 

 

REST의 장단점

장점

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

 

단점 

• 표준이 자체가 존재하지 않아 정의가 필요하다.
• 사용할 수 있는 메소드가 4가지밖에 없다.
• HTTP Method 형태가 제한적이다.
• 구형 브라우저에서 호환이 되지 않아 지원해주지 못하는 동작이 많다.

 

 

REST API란

 

REST API의 개념

REST를 기반으로 서비스 API를 구현한 것

 

REST API 설계 규칙

• URI는 정보의 자원을 표현해야 한다.
  
  • 리소스명은 동사보다는 명사를 사용

GET /members/1

 

• 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE 등)으로 표현한다.
  • URI에 HTTP Method가 들어가면 안된다.

// URI에 DELETE 메서드가 들어가면 안된다.
GET /members/delete/1

// 자원에 대한 행위는 HTTP Method로 표현 
DELETE /members/1

 

HTTP Method의 역할

POST : POST를 통해 해당 URI를 요청하면 리소스를 생성

GET : GET을 통해 해당 리소스 조회. 해당 도큐먼트에 대한 자세한 정보도 가져옴

PUT : PUT을 통해 해당 리소스 수정
DELETE : DELETE를 통해 해당 리소스 삭제

 

설계 시 주의사항

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

http://restapi.example.com/houses/apartments

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

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

• 하이픈(- )은 URI 가독성을 높이는데 사용
• URI 경로에는 소문자가 적합하다.
• 파일확장자는 URI에 포함하지 않는다.

 

HTTP 응답 상태 코드

상태 코드
1xx (정보)	전송 프로토콜 수준의 정보 교환
2xx (성공)	클라어인트 요청이 성공적으로 수행됨
3xx (리다이렉션 완료)	클라이언트는 요청을 완료하기 위해 추가적인 행동을 취해야 함
4xx (요청오류)	클라이언트의 잘못된 요청
5xx (서버오류)	서버쪽 오류로 인한 상태코드

 

RESTful이란

RESTful이란 REST의 원리를 따르는 시스템을 의미합니다. REST API의 설계 규칙을 올바르게 지킨 시스템을 RESTful하다 말할 수 있다.

 

 

참고자료

https://appmaster.io/blog/what-rest-api-and-how-it-differs-other-types

https://meetup.toast.com/posts/92

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

https://khj93.tistory.com/entry/%EB%84%A4%ED%8A%B8%EC%9B%8C%ED%81%AC-REST-API%EB%9E%80-REST-RESTful%EC%9D%B4%EB%9E%80