[Spring boot] REST API에 대해

REST(Represetional State Transfer) API

REST란 HTTP URI를 통해 자원을 명시하고, HTTP method를 통해 해당 자원에 대한 생성, 조회, 갱신, 삭제 등의 명령을 적용할 수 있는 분산 하이퍼미디어 시스템을 위한 소프트웨어 아키텍쳐이다.

-> REST : 웹의 장점을 최대한으로 활용할 수 있는 소프트웨어 아키텍쳐이다!

REST API는 REST 기반으로 서비스 API를 구현한 것이라 할 수 있다.

 

REST API의 탄생 일화

2000년도에 Roy Fielding의 박사 학위 논문에서 최초로 소개되었다. 로이 필딩은 HTTP의 주요 저자 중 한 사람으로 그 당시 HTTP 설계의 우수성에 비해 제대로 사용되어지지 못하는 모습이 안타까워 웹의 장점을 최대한으로 활용할 수 있는 아키텍쳐로 REST를 발표했다고 한다.

 

REST의 구성

• 자원(RESOURCE) - URI
  Ex) /groups/group_id 같은 HTTP URI
• 행위(Verb) - HTTP Method
  HTTP 프로토콜의 Method(GET, POST, PUT, DELETE)
• 표현(Represetaions)
  REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타내어 질 수 있다.

 

REST 특징

• Uniform(유니폼 인터페이스)
  : URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍쳐 스타일로 HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용 가능하다. -> 특정 언어나 기술에 종속되지 않는다.
• Stateless(무상태성)
  : 작업을 위한 상태정보를 따로 저장하고 관리하지 않는다. 세션 정보나 쿠키 정보를 별로도 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리함으로써 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않아 구현이 단순해진다.
• Cacheable(캐시 가능)
  : HTTP라는 기존 웹표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존의 인프라를 그대로 활용 가능하다. 따라서 HTTP가 가진 캐싱 기능이 적용 가능하다.
• Self-descriptiveness(자체 표현 구조)
  : REST API 메시지만 보고 이를 쉽게 이해할 수 있는 자체 표현 구조로 되어 있다.
• Client-Server 구조
  : 서버는 API제공, Client는 사용자 인증이나 컨텍스트(세션, 로그인 정보) 등을 직접 관리하는 구조, 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야할 내용이 명확해지고 서로간의 의존성이 낮아진다.
• 계층형 구조
  : REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가하여 구조상의 유연성을 둘 수 있고 PROXY, 게이트 웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게 한다.

 

REST API 디자인 가이드

- URI는 정보의 자원을 표현해야 한다.

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

REST API 중심 규칙

1. URI는 정보의 자원을 표현해야한다. (리소스명은 되도록 명사를 사용) 

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

Method	역할
GET	리소스 조회, 정보를 조회, 요청할 때 주로 사용
POST	리소스 생성, 새로운 정보를 생성할 때 주로 사용
PATCH	PUT과 동일한 역할을 수행하지만, 리소스의 일부분만 수정할 때 사용한다.
PUT	리소스 수정, 이미 생성된 리소스를 수정할 때 주로 사용
DELETE	리소스 삭제

안좋은 예 : GET /products/delete/1
좋은 예 : GET /products/1

 

위의 안좋은 예시 처럼 delete같은 행위가 URI에 들어가는 것은 안좋다!

 

URI 설계 시 주의점

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

2. URI 마지막 문자로 구분자(/)를 포함하지 않는다.

3. 하이폰(-)은 URI의 가독성을 높이는데 사용한다.

4. 밑줄(_)은 URI에 사용하지 않는다.

5. URI 경로에는 소문자를 사용한다.

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

 

HTTP 응답 상태 코드

상태코드	의미
200	클라이언트 요청 정상 수행
201	클라이언트가 어떤 리소스 생성을 요청, 해당 리소스가 성공적으로 생성됨(POST를 통한 리소스 생성 작업 시)

상태코드	의미
400	클라이언트 요청이 부적절 할 경우 응답 코드
401	클라이언트가 인증되지 않는 상태에서 보호된 리소스를 요청했을 때의 응답 코드 Ex) 로그인 하지 않은 유저가 로그인 했을 때 요청 가능한 리소스를 요청했을 때
403	유저 인증상태와 관계 없이 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때
405	클라이언트가 요청한 리소스에서는 사용 불가능한 Method를 이용했을 경우

상태코드	의미
301	클라이언트 요청한 리소스에 대한 URI가 변경 되었을 때 사용하는 응답 코드 (응답 시 Location header에 변경된 URI를 적어줘야 한다)
500	서버에 문제가 있을 경우 사용하는 응답 코드

 

Spring Boot REST API 서버 사용 예시

사용법은 간단하다.. 그저 요청을 처리하는 Controller Class 위에 어노테이션만 하나 선언해주면 다음과 같은 방식으로 사용할 수 있다.

 

REST API와 RESTful API?

RESTful은 REST의 설계 규칙을 잘 지켜서 설계된 API를 RESTful한 API라고 한다.
즉, REST의 원리를 잘 따르는 시스템을 RESTful이란 용어로 지칭된다.

 

RESTful API 목적

• 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것
• RESTful한 API를 구현하는 근본적인 목적이 성능 향상에 있는 것이 아니라 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이 주 이유이다. 따라서 성능이 중요한 상황에서는 굳이 RESTful한 API를 구현할 필요는 없다.

 

 

 

 

Reference: https://meetup.toast.com/posts/92, https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html