[BE] REST API

1. REST (Representational State Transfer)

• 어떤 자원에 CRUD 연산을 수행하기 위해 URI로 요청을 보내는 것
• HTTP URI를 통해 자원을 명시하고, HTTP Method를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것
• 각 요청이 어떤 동작이나 정보를 위한 것인지를 그 요청의 모습 자체로 추론 가능

1-1. 구성요소

1) 자원(Resource) : HTTP URI

2) 자원에 대한 행위(Verb) : HTTP Method (GET, POST, PUT(PATCH), DELETE)

3) 자원에 대한 행위의 내용(Representations) : HTTP Message Payload (JSON, XML, RSS 등)

1-2. REST가 왜 필요한가?

각 요청의 의도를 파악하기 쉽고 사용하기 쉬운 API를 제작하기 위해서

1️⃣ GET /deleteUserInfo/id?=3
2️⃣ DELETE /users/3

위의 두 요청은 모두 특정 user의 정보를 삭제하는 API 이지만, 첫 번째 API는 RESTful하지 못하다.

1-3. REST 특징

1) Uniform (유니폼 인터페이스)

Uniform Interface는 URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일

2) Stateless (무상태성)

REST는 무상태성 성격을 갖는다. 다시 말해 작업을 위한 상태정보를 따로 저장하고 관리하지 않는다. 세션 정보나 쿠키 정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 된다. 때문에 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해진다.

3) Cacheable (캐시 가능)

REST의 가장 큰 특징 중 하나는 HTTP라는 기존 웹표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용이 가능하다. 따라서 HTTP가 가진 캐싱 기능이 적용 가능하다. HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.

4) Self-descriptiveness (자체 표현 구조)

REST API 메시지만 보고도 이를 쉽게 이해할 수 있는 자체 표현 구조로 되어 있다.

5) Client-Server 구조

REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어들게 된다.

6) 계층형 구조

REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게 한다.

 

2. API (Application Programming Interface)

소프트웨어가 다른 소프트웨어로부터 지정된 형식으로 요청, 명령을 받을 수 있는 수단

서비스나 프로그램 간에 미리 정해진 기능을 실행할 수 있도록 하는 규약

 

3. REST API

REST 원칙을 적용하여 서비스 API를 설계한 것

HTTP 요청을 보낼 때 어떤 URI에 어떤 메소드를 사용할지 (+기타) 널리 쓰이는 일종의 형식

3-1. REST API의 핵심

1) URI는 리소스를 표현해야 한다.

• 리소스 명은 동사가 아닌 명사를 사용해야 한다.

/students/1

• 리소스는 Collection과 Document로 표현할 수 있다.

/locations/seoul/schools/3

이 때, Collection은 복수를 사용한다. 여기서 locations는 Collection을, seoul은 Document를 표현한다.

2) 그 리소스에 대한 행위는 HTTP의 Method로 표현해야 한다.

• GET은 리소스를 조회한다. (학생 목록 조회)

GET /students

• POST는 리소스를 생성한다. (학생 생성)

POST /students

• PUT은 리소스를 업데이트한다. (1번 학생 정보 업데이트)

PUT /students/1

• DELETE는 리소스를 삭제한다. (1번 학생 삭제)

DELETE /students/1

3-2. 잘못된 REST 사용

GET/POST의 부적합한 사용 : 기존의 조회/생성 기능이 아닌 다른 방식으로 사용하는 경우

자체 표현적이지 않음 : REST의 특징 중 하나인 자체표현성에서 떨어지는 경우로, 이해하기 어렵다.

HTTP 응답코드 미사용 : 요청에 대한 응답의 상태코드를 명확하게 정의하지 않은 경우

 

 

 

참고

https://velog.io/@ellyheetov/REST-API

https://velog.io/@nawhew/%EB%82%B4%EA%B0%80-%EB%A7%8C%EB%93%A0-REST-API%EB%8A%94-%EC%A7%84%EC%A7%9C-REST%ED%95%9C%EA%B0%80

https://www.youtube.com/watch?v=iOueE9AXDQQ