[WEB] REST

REST

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

• URL을 통해 자원을 명시
• HTTP Method를 통해 CRUD를 지원한다.
  • CRUD : Create, Read, Update, Delete의 약자로 데이터 처리 기능인 생성, 읽기, 갱신, 삭제를 일컫는다.

URL을 통해 자원을 명시하고 HTTP Method를 통해 CRUD를 지원하여 PayLoad을 반환한다.
payload는 주로 JSON, XML을 통해 주고받는것이 일반적이다.

REST 특징

1. Server-Client

• 자원을 제공하는 곳이 Server, 요청하는 쪽이 Client
• Server: API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다.
• Client: 사용자 인증, 세션, 로그인정보 등을 직접 관리하고 책임진다.
• 의존성이 줄어든다.

2. Stateless

• HTTP 프로토콜이 Stateless이므로 REST 역시 무상태성을 가진다.
• Server는 Client의 세션, 로그인 정보를 저장하지 않기에 구현이 단순하다.
• Server는 Client의 요청을 별개의 것으로 인식한다.

3. Cacheable

• HTTP 프로토콜을 그대로 사용하므로 기존의 인프라를 그대로 활용할 수 있다. HTTP 프로토콜의 핵심적인 기술인 caching 구현이 용이하다.
• 빠른 처리(응답시간, 성능, 서버의 자원 이용률)을 위해 캐시가 요구된다.

4. Layered System

• Server는 계층화할 수 있으며, Client는 REST API server만 호출한다. API 서버는 비즈니스 로직만 수행하며 다른 계층에서 로드밸런싱, 암호화, 사용자 인증 등 구현해놓을 수 있다.

5. Uniform Interface

• HTTP 표준 프로토콜을 따르는 모든 플랫폼에서 사용이 가능하다는 장점이 있다.

장단점

장점

1. HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구출할 필요가 없다.
2. HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해 준다.
3. HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
4. Hypermedia API의 기본을 충실히 지키면서 범용성을 보장한다.
   REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.
5. 여러 가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다.
6. 서버와 클라이언트의 역할을 명확하게 분리한다.

단점

1. 표준이 자체가 존재하지 않아 정의가 필요하다.
2. HTTP Method 형태가 제한적이다.
3. 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 정보의 값을 처리해야 하므로 전문성이 요구된다.
4. 구형 브라우저에서 호환이 되지 않아 지원해주지 못하는 동작이 많다.(익스폴로어)

REST API = REST + API(Application Programming Interface)

RESTful

REST 아키텍처를 구현하는 웹서비스를 말하는 용어이다.
REST API는 RESTful하다.

이해하기 쉽고 사용하기 쉬운 api를 만드는 것이 목적이며 성능이 중요한 시스템의 경우 RESTful하게 api를 구현할 필요가 없다.

REST API 설계규칙

자원은 동사보다 명사를, 대문자보다 소문자를 사용해야한다.
인스턴스는 단수명사를 사용한다.
컬렉션, 스토어는 복수명사를 사용한다.
URI에 HTTP Method가 들어가면 안된다.
URI에 CRUD에 관한 동사표현이 들어가면 안된다.
/는 계층 관계를 나타내는데 사용한다.
URI가 긴 경우 -을 사용하여 가독성을 높인다.
_은 URI에 사용하지 않는다.

++ 응답 상태 코드

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

++ URL과 URI

URL은 식별자 + 위치를 말하며 URI는 식별자를 말한다.
ex) https://hufs.ac.kr
URL = https://hufs.ac.kr
URI = hufs.ac.kr

API 명세서

추가로 팀프로젝트시 효과적인 의사소통을 위해 API 명세서 작성하는 방법을 공부하고 있습니다.

https://www.postman.com/slackhq/workspace/slack-api/api/89151223-9b3c-49aa-bd2e-f087c7dd4160/definition/008fd418-7e87-46a4-9282-946584ba49de/file/008fd418-7e87-46a4-9282-946584ba49de

index.json | Slack API | Postman API Network

참고자료

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

[Network] REST란? REST API란? RESTful이란? - Heee's Development Blog

https://velog.io/@kdh10806/REST-API-RESTful-API

REST API, RESTful API

https://www.elancer.co.kr/blog/view?seq=74 

URI와 URL, 어떤 차이점이 있나요? | 이랜서 블로그

https://sanghaklee.tistory.com/57

RESTful API 설계 가이드