REST 구성

쉽게 말해서 REST API는 다음의 구성으로 이루어져 있습니다.

• 자원 - URI
• 행위 - HTTP METHOD
• 표현

특징

1) Uniform(유니폼 인터페이스)
Uniform interface는 URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처를 말합니다.

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

3) Cacheable(캐시 가능)
REST의 가장 큰 특징 중 하나는 HTTP라는 기존 웹표준을 그대로 사용하기 떄문에, 웹에서 사용하는 기존 인프라를 그대로 활용이 가능합니다. 따라서 HTTP가 가진 캐싱 기능이 적용 가능합니다.

4) Self-descriptiveness(자체 표현 구조)
REST의 또 다른 큰 특징 중 하나는 REST API메세지만 보고도 이를 쉽게 이해 할 수 있는 자체 표현 구조로 되어있습니다

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

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

REST API 디자인 가이드

첫 번째, URI는 정보의 자원을 표현해야 합니다.
두 번쨰, 자원에 대한 행위는 HTTP Method(GET,POST, PUT, DELETE)로 표현합니다.

REST API 규칙

1) URI는 정보의 자원을 표현해야 합니다.(리소스명을 동사가 아닌 명사를 사용)

위와 같은 방식은 REST를 제대로 적용하지 않은 URL입니다. URL는 자원을 표현하는데 중점을 두어야 합니다.

2) 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE 등)로 표현
위의 잘못된 URI를 HTTP Method를 통해 수정하면

회원정보를 가져오는 URI

회원을 추가할 때

URI 설계 시 주의 할 점

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

2) URI 마지막 문자로 (/)를 포함하지 않습니다.

3) 하이픈(-)은 URI 가독성을 높이는데 사용

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

5) URI 경로에는 소문자가 적합합니다.

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

리소스 간의 관계표현

REST 리소스 간에는 연관 관계가 있을 수 있고, 이런 경우 다음과 같은 표현방법을 사용합니다.

만약에 관계명이 복잡하다면 이를 서브 리소스에 명시적으로 표현하는 방법이 있습니다. 예를 들어 사용자가 좋아하는 디바이스 목록을 표현해야 할 경우 다음과 같은 형태로 사용할 수 있습니다.

HTTP 응답상태 코드