REST란? REST API 와 RESTful API

 

REST 란?

REST의 정의

자원을 표현으로 구분해 정보를 주고 받는 모든 것을 의미합니다.

이게 무슨 말일까.. 이해가 가지 않았습니다.

 

자원(Resource) : 해당 소프트웨어가 관리하는 모든 것 (그림, 데이터)

대부분의 글에 위와 같이 되어있는데 정확하게는 이해를 못했습니다. 그래서 제 생각을 정리합니다.

http://torang.co.kr/user/107 만약 클라이언트가 다음과 URI로 요청을 보낼 수 있을 때 서버 쪽에서는 응답을 위해 DB에 user 에 대한 데이터를 저장하고 있을 겁니다. 이를 자원(Resource) 라고 생각하기로 했습니다.

 

그런데 이 부분과는 관련이 없지만 URI 와 URL가 뭐가 다른지에 대해 헷갈리기 시작했습니다. 😂..

우선 URI 가 URL 을 포괄하는 용어입니다. 다음 URL은 http://torang.co.kr/user user의 자원을 요청하는 것을 의미합니다. 그리고  http://torang.co.kr/user/107 은 107번째 유저를 의미하는 식별자가 붙어있기 때문에 URI 를 의미합니다. 이렇게 URI 와 URL 은 식별자에 의해 구분이 되지 않나? 라고 생각을 정리하게 되었습니다.

 

표현(Representation): 자원을 표현하는 방식 

표현은 또 뭔고.. 라는 생각이 들었고 다음글을 읽고 제 생각을 정리합니다. 

아래 그림 처럼 흔히 GET 요청에 대한 응답을 Resource 라고 할 수도 있지만 엄격하게 따지자면 아래의 응답은 표현이라고 할 수 있습니다. 왜냐하면 자원을 클라이언트에 요구사항에 맞게 대응하여 서버가 응답을 하는 것이기 때문입니다. 예를 들자면 클라이언트가 XML 로 요청을 보낼 경우 그에 맞게 XML 데이터로 응답을 하는 것이죠. 이렇게 클라이언트 입맛에 맞게 자원을 바꿔 응답한다~ 라는 점에서 아래의 응답은 표현이다~ 라고 생각하기로 했습니다. (같은 URI로 요청을 하는 경우 클라이언트의 헤더 필드(XML, JSON)에 따라 다른 데이터 형식으로 응답이 가능한가? 에 대해 궁금하신분은 다음글을 참고하시면 되겠습니다.)

 

상태전달: 데이터가 요청되는 시점에 맞게 표현된 데이터를 전달합니다.

 

이러한 REST 는 HTTP 프로토콜을 그대로 활용한다는 특징이 있으며, 네트워크 상에서 Client 와 Server 사이의 통신 방식 중 하나입니다.

 

REST의 개념

어떤 자원에 대해 CRUD(Create, Read, Update, Delete) 연산을 수행하기 위해 URI(Resource)로 GET, POST 등의 방식(Method)를 사용하여 요청을 보내며, 요청을 위한 자원은 특정한 형태(Representation of Resource)로 표현됩니다.

 

 

REST의 구성 요소

1. 자원(Resource) - URI 

• 모든 자원에는 고유한 ID가 존재하고, 이 자원은 Server에 존재합니다.
• 자원을 구별하는 ID(식별자)는 '/user/107' 과 같은 HTTP URI 입니다.
• Client는 URI를 이용해 자원을 지정하여 Server 에 요청합니다.

2. 행위(Verb) - Method

• HTTP 프로토콜의 Method를 사용합니다.
• HTTP 프로토콜은 GET, POST, PUT, PATCH, DELETE의 Method를 제공합니다. (CRUD)

3. 표현 (Representation of Resource)

• Client 와 Server 가 데이터를 주고 받는 형태로 JSON, XML, TEXT, RSS 등이 있습니다.
• JSON, XML을 통해 데이터를 주고 받는 것이 일반적입니다.

 

REST의 특징

1. Server-Client (서버-클라이언트 구조)

• 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 됩니다.
  • REST Server는 API 를 제공하고 비즈니스 로직 처리 및 저장을 책임집니다.
  • Client 는 사용자 인증이나 로그인 정보를 관리합니다.
  • 역할을 확실히 구분함으로 서로 간의 의존성이 줄어듭니다.

 

2. Stateless (무상태)

• HTTP 프로토콜은 Stateless Protocol 이므로 REST 역시 무상태성을 갖습니다.
• Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리합니다.
  • 이전 요청이 다음 요청의 처리에 연관되어서는 안됩니다.

 

3. Cacheable (캐시 처리 기능)

• HTTP의 캐싱 기능을 적용할 수 있습니다.
• HTTP 프로토콜 표준에서 사용하는 Last-Modified Tag 또는 E-Tag를 이용해 캐싱을 구현합니다.

 

4. Layered System (계층 구조)

• Client는 REST API Server만 호출합니다.
• REST Server는 다중 계층으로 구성될 수 있습니다.
  • 보안, 로드 밸런싱, 암호화 등을 위한 계층을 추가하여 구조를 변경할 수 있습니다.
  • Proxy, Gateway와 같은 네트워크 기반의 중간 매체를 사용할 수 있습니다.
  • 하지만 Client는 Server와 직접 통신하는지, 중간 서버와 통신하는지 알 수 없습니다.

 

5. Uniform Interface (인터페이스 일관성)

• URI로 지정한 Resource에 대한 요청을 통일되고, 한정적으로 수행하는 아키텍처 스타일을 의미합니다. 
• HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능합니다. (특정 언어나 기술에 종속되지 않음)

무슨 말인고 했는데 클라이언트가 안드로이드, IOS , 웹이든간에 HTTP 요청을 할 수 있다는 것을 의미한다는 것으로 이해했다.

 

6. Self-Descriptiveness (자체 표현)

• 메세지만 보고도 쉽게 이해할 수 있는 자체 표현 구조로 되어있습니다.

Self-Descriptiveness 가 무엇인지 모르겠어서 공부를 하다보니 데이터의 상태코드나 json response , method, URI 의 네이밍을 통해 어떤 자원을 참조하는지 가 모두 Self-Descriptiveness 가 된다고 정리하게 되었습니다. 

 

하지만 다음글에는 위와 같은 정보로도 Self-Descriptiveness 에 충족하지 않는다. 아직 부족하다는 의견이 있었습니다. 이 부분에 대해서는 정답이 있는 것 같지는 않고 어떤팀은 json response + 상태코드 + method + 어떤 자원을 요청하는지 알 수 있는 네이밍 정도가 RESTful 이라고 생각할 수 있기 때문에 팀과 소통해야하는 컨벤션적인 문제인 것 같았습니다. 

 

 

REST API 란?

REST API 정의

REST의 특징을 기반으로 서비스 API 를 구현한 것

 

REST API 정의

URI는 정보의 자원만 표현해야 하며, 자원의 행위는 HTTP Method에 명시한다는 것입니다.

 

REST API 디자인 가이드

• URI는 정보의 자원을 표현해야 한다.
• 자원에 대한 행위는 HTTP Method(GET, POST, PUT, PATCH, DELETE)로 표현한다.

 

REST API의 설계 규칙

1. URI는 명사를 사용한다. (리소스명은 동사가 아닌 명사를 사용해야한다.)

1-1. 아래와 같은 동사를 사용하지 말 것

• /getAllUsers
• /getUserById
• /createNewUser
• /updateUser
• /deleteUser

 

2. 슬래시( / )로 계층 관계를 표현한다.

 

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

 

4. 밑줄( _ )을 사용하지 않고, 하이픈( - )을 사용한다.

 

5. URI는 소문자로만 구성한다.

 

6. HTTP 응답 상태 코드 사용

- 클라이언트는 해당 요청에 대한 실패, 처리완료 또는 잘못된 요청 등에 대한 피드백을 받아야한다.

 

7. 파일확장자는 URI에 포함하지 않는다.

- http://ehddud100677.tistory.com/restapi/1006/photo.jpg (x) 

 

 

REST API 와 RESTful API 의 차이는 뭘까?

RESTful은 REST의 설계 규칙을 잘 지켜서 설계된 API를 RESTful한 API라고 합니다.

즉, REST의 원리를 잘 따르는 시스템을 RESTful이란 용어로 지칭됩니다.

RESTful API 과 REST API 의 차이가 무엇인지 잘 이해할 수 없었습니다. 정리하자면 Restful 이 좀 더 포괄적인 범위라고 생각합니다. REST API 의 설계 규칙을 잘 따르며 요청 URI 만 보더라도 어떤 정보를 요청하는지 알 수 있을 때 RESTful 하다 라고 할 수 있을 것 같습니다.

 

RESTful하게 만든 API는 요청을 보내는 주소만으로도 어떤 것을 요청 하는지 파악이 가능합니다.

예를들어, https://school.com/grade 의 주소는 학교의 학년들을 목록으로 받는 요청일 것입니다.

{
"results" : [
    {"idx": 1, "name": "1학년"},
    {"idx": 2, "name": "2학년"},
    {"idx": 3, "name": "3학년"}
    ]
}

 

https://school.com/grade/2 이렇게 idx, 고유번호가 붙는다면, idx가 2인 학년의 정보가 올 겁니다.

그리고 https://school.com/grade/2/students 의 students가 붙으면 2반 학생들의 정보를 받아올 수 있습니다.

 

{
"results" : [
    {"idx": 1, "name": "홍길동", "gender": "male"},
    {"idx": 2, "name": "성춘향", "gender": "female"},
    {"idx": 3, "name": "전우치", "gender": "male"},
    {"idx": 4, "name": "나기백", "gender": "male"},
    ...
    ]
}

 

또, https://school.com/grade/2/students/15 라는 idx를 붙이면 그 학생들 중 15의 idx를 가진 학생의 정보가 오겠죠.

혹은 https://school.com/grade/2/students?gender=male 와 같이 조건을 붙여서 남학생들의 정보만 받아올 수도 있습니다.

한 페이지당 10명의 데이터를 받아오는 거라면 이런식으로도 표현이 가능합니다.

https://school.com/grade/2/students?page=2&count=10

 

{
"results" : [
    {"idx": 11, "name": "신짱구", "gender": "male"},
    {"idx": 12, "name": "김지우", "gender": "female"},
    {"idx": 13, "name": "김화석", "gender": "male"},
    {"idx": 14, "name": "박수쳐", "gender": "male"},
    ...
    ]
}

 

참고자료 

https://dev-coco.tistory.com/97