REST, REST API, RESTful API

🚗 REST

🪐 REST의 정의

• Representational State Transfer : 대표적인 상태 전달
• REST란, 웹에 존재하는 모든 자원(이미지, 동영상, DB자원 등)에 고유한 URL을 부여 해 활용하는 것.
  • 즉, 자원을 정의하고 자원에 대한 주소를 지정하는 방법론을 의미한다.
  • 일종의 Coding Convention
  • 즉, 자원(resource)의 표현(representation) 에 의한 상태 전달)

❓ 자원(resource)의 표현(representation)
자원: 해당 소프트웨어가 관리하는 모든 것
Ex) 문서, 그림, 데이터, 해당 소프트웨어 자체 등

자원의 표현: 그 자원을 표현하기 위한 이름
Ex) DB의 학생 정보가 자원일 때, ‘students’를 자원의 표현으로 정한다.

상태(정보) 전달:

• 데이터가 요청되어지는 시점에서 자원의 상태(정보)를 전달한다.
• JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.
• 월드 와이드 웹(www)과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 개발 아키텍처의 한 형식

REST는 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일이다.

---

REST는 네트워크 상에서 Client와 Server 사이의 통신 방식 중 하나이다.

❗ 따라서 RESTful API란, REST의 특징을 지키면서 API를 제공하는 것을 의미한다.
❗ RESTful API란, 결국 HTTP 프로토콜 장점을 살릴 수 있는 네트워크 기반 아키텍처를 뜻한다.

---

🪐 REST가 필요한 이유(등장배경)

• 애플리케이션 분리 및 통합
  애플리케이션의 복잡도가 증가하면서 애플리케이션을 어떻게 분리하고 통합 하느냐가 주요 이슈가 되었고, 이에 REST가 이슈가 되었다.

• 다양한 클라이언트의 등장
  모바일과 같은 다양한 클라이언트가 등장하면서 backend 하나로 다양한 디바이스를 대응하기 위해 REST의 필요성이 증대하였다.

이러한 멀티 플랫폼에 대한 지원을 위해 서비스 자원에 대한 아키텍처를 세우고 이용하는 방법을 모색한 결과, REST에 관심을 가지게 되었다.

---

🪐 REST의 구체적인 개념

HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미한다.

즉, REST는 자원 기반의 구조(ROA, Resource Oriented Architecture) 설계의 중심에 Resource가 있고,
HTTP Method를 통해 Resource를 처리하도록 설계된 아키텍쳐를 의미한다.

웹 사이트의 이미지, 텍스트, DB 내용 등의 모든 자원에 고유한 ID인 HTTP URI를 부여한다.

❓ URI (Uniform Resource Indenfier)
웹서버의 리소스는 각자 이름을 가지고 있기 때문에, 클라이언트는 이러한 이름을 통해 원하는 정보를 찾을 수 있다.
이때 서버 리소스의 이름을 통합 자원 식별자 또는 URI 라고 부른다.

예를들어, 카카오 사이트를 접속하여 news라는 메뉴를 클릭했다고 가정해보자.
메뉴를 클릭하면 https://www.kakaocorp.com/kakao/introduce/news 와 같이 URI 가 생성된다.

• https:// 👉 HTTP 프로콜을 사용한다는 뜻 (뒤의 s 는 기존 프로콜에서 보안이 강화된 버전)
• www.kakaocorp.com 👉 카카오 사이트의 주소
• /kakao/introduce/vision 👉 리소스 위치

---

❓ CRUD Operation
Create : 생성(POST)
Read : 조회(GET)
Update : 수정(PUT)
Delete : 삭제(DELETE)
HEAD: header 정보 조회(HEAD)

---

🪐 REST의 장단점

• 장점

  • HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구출할 필요가 없다.

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

  • Hypermedia API의 기본을 충실히 지키면서 범용성을 보장한다.

  • REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바(목적)를 쉽게 파악할 수 있다.

    ex) 요청 내용을 보고 쉽게 해석이 가능하다.
    https://api.trueshort.com/stock/003890 의 주소만 봐도,
    https://api.trueshort.com 라는 API에서 A전자 주식에 관한 정보를 HTTP 요청을 통해 받아온다" 라고 해석이 쉽게 가능하다.

  • 여러가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다.

  • 서버와 클라이언트의 역할을 명확하게 분리한다.

• 단점

  • 표준이 존재하지 않는다.
  • 사용할 수 있는 메소드가 4가지 밖에 없다. (HTTP Method 형태가 제한적)
  • 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 값이 왠지 더 어렵게 느껴진다.
  • 구형 브라우저가 아직 제대로 지원해주지 못하는 부분이 존재한다. (PUT, DELETE를 사용하지 못하는 점 / pushState를 지원하지 않는 점)

  ---

🪐 REST 구성 요소

• 자원(Resource): URI
  • 모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
  • 자원을 구별하는 ID는 ‘/groups/:group_id’와 같은 HTTP URI 다.
  • Client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다.
• 행위(Verb): HTTP Method
  • HTTP 프로토콜의 Method를 사용한다. (HTTP 프로토콜은 GET, POST, PUT, DELETE 와 같은 메서드를 제공한다.)
• 표현(Representation of Resource)
  • Client가 자원의 상태(정보)에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation)을 보낸다.
  • REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타내어 질 수 있다.
  • JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.

🚖 REST의 구성

• 자원 (Resouce) - URI
• 행위 (Verb) - HTTP Method
• 표현 (Representations)

EX)
/users GET
/users/{id} GET
/users PUT

---

예시) REST 방식이 적용된 RESTful API

• A주식 정보를 받기 위한 HTTP 요청
  👉 HTTP GET https://api.trueshort.com/stock/003890
  [HTTP] / [Method(GET): How to] / [what]

• 유저의 보유 주식 종목들을 DB에 저장하는 HTTP 요청
  👉 HTTP POST https://api.trueshort.com/users/portfolios
  [HTTP] / [Method(POST): How to] / [what]

🚀 Client가 Server에게 요청하는 방식.

• HTTP Method (4가지)
  • POST
  • GET
  • PUT(전체수정 요청, 새로 덮어씌우는 것),
  • DELETE(데이터 삭제 요청),
  • PATCH(일부 수정 요청)
• 4가지 연산 = INSERT, SELECT, UPDATE, DELETE
• Payload = HTTP request에서 server로 보내는 데이터(body)
• URL : http://x.x.x.x:00000/path1/filename.txt
• URI : http://x.x.x.x:00000/products/smartphone

❗ URI (Uniform Resource Identifier)
: 해당 사이트의 특정 자원의 위치를 나타내는 유일한 주소

---

🪐 REST 특징

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

  • HTTP 표준에만 따른다면, 안드로이드/IOS 플랫폼이든, 특정 언어나 기술에 종속되지 않고 모든 플랫폼에 사용이 가능하며, URI로 지정한 리소스에 대한 조작이 가능한 아키텍처 스타일을 의미한다.

• Self-descriptiveness (자체 표현 구조) : 동사(Method) + 명사(URI) 로 이루어져있어 어떤 메서드에 무슨 행위를 하는지 알 수 있으며, 메시지 포맷 역시 JSON을 이용해서 직관적으로 이해가 가능한 구조로, REST API 메시지만 보고도 이를 쉽게 이해할 수 있다.

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

  • 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 된다.

  • REST Server: API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다.

  • Client: 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임진다.
    서로 간 의존성이 줄어든다.

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

• Stateless(무상태)

  • HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 갖는다.
  • Client의 context를 Server에 저장하지 않는다.
    즉, 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 되므로 구현이 단순해진다. (저장소에 상태정보를 따로 저장하고 관리하지 않고, API 서버는 들어오는 요청만을 단순 처리하면 된다.)
  • Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다.
  • 각 API 서버는 Client의 요청만을 단순 처리한다. 👉 즉, 이전 요청이 다음 요청의 처리에 연관되어서는 안된다.(일회성)
    ❗ 물론 이전 요청이 DB를 수정하여 DB에 의해 바뀌는 것은 허용한다.
  • Server의 처리 방식에 일관성을 부여하고 부담이 줄어들며, 서비스의 자유도가 높아진다.

• Cacheable(캐시 처리 가능)

  • 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다.
    즉, HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있다.
  • HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.
  • 대량의 요청을 효율적으로 처리하기 위해 캐시가 요구된다.
  • 캐시 사용을 통해 응답시간이 빨라지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있다.

---

🚗 REST API

• API(Application Programming Interface)란
  데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간 상호작용을 촉진하며, 서로 정보를 교환가능 하도록 하는 것
• REST API의 정의
  • REST 기반으로 서비스 API를 구현한 것
  • 최근 OpenAPI(누구나 사용할 수 있도록 공개된 API: 구글 맵, 공공 데이터 등), 마이크로 서비스(하나의 큰 애플리케이션을 여러 개의 작은 애플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍처) 등을 제공하는 업체 대부분은 REST API를 제공한다.
• REST API의 특징
  • 사내 시스템들도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있다.
  • REST는 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현할 수 있다.
    즉, REST API를 제작하면 델파이 클라이언트 뿐 아니라, 자바, C#, 웹 등을 이용해 클라이언트를 제작할 수 있다.

🪐 REST API의 특징

• REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있다.
• REST는 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현할 수 있다.

💡 REST API 설계 기본 규칙

참고 리소스 원형

도큐먼트(document) : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념
컬렉션(collection) : 서버에서 관리하는 디렉터리라는 리소스
스토어(store) : 클라이언트에서 관리하는 리소스 저장소

---

1) URI는 정보의 자원(resource)을 표현해야 한다.

• resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다.
• resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다.
• resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다.
• resource의 스토어 이름으로는 복수 명사를 사용해야 한다.

Ex) GET /Member/1 👉 GET /members/1

---

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

• URI에 HTTP Method가 들어가면 안된다.
  Ex) GET /members/delete/1 👉 DELETE /members/1

• URI에 행위에 대한 동사 표현이 들어가면 안된다.(즉, CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.)
  Ex) GET /members/show/1 👉 GET /members/1
  Ex) GET /members/insert/2 👉 POST /members/2

• 경로 부분 중 변하는 부분은 유일한 값으로 대체한다.(즉, :id는 하나의 특정 resource를 나타내는 고유값이다.)
  Ex) student를 생성하는 route 👉 POST /students
  Ex) id=12인 student를 삭제하는 route 👉 DELETE /students/12

---

• REST API 설계 규칙

  • 슬래시 구분자(/)는 계층 관계를 나타내는데 사용한다.
    Ex) http://restapi.example.com/houses/apartments

  • URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 한다.

  • REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않는다.
    Ex) http://restapi.example.com/houses/apartments/ (X)

  • 하이픈(- )은 URI 가독성을 높이는데 사용 👉 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.

  • 밑줄(_ )은 URI에 사용하지 않는다. 👉 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않는다.

  • URI 경로에는 소문자가 적합하다. 👉 URI 경로에 대문자 사용은 피하도록 한다.
    (RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문)

  • 파일확장자는 URI에 포함하지 않는다. 👉 REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.

  • Accept header를 사용한다.
    Ex) http://restapi.example.com/members/soccer/345/photo.jpg (X)
    Ex) GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg (O)

  • 리소스 간에는 연관 관계가 있는 경우
    /리소스명/리소스 ID/관계가 있는 다른 리소스명
    Ex) GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

---

• REST API 설계 예시

참고 응답상태코드

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

🚗 RESTful

• RESTful은 일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어이다.
• ‘REST API’를 제공하는 웹 서비스를 ‘RESTful’하다고 할 수 있다.
• RESTful은 REST를 REST답게 쓰기 위한 방법으로, 누군가가 공식적으로 발표한 것이 아니다.
  즉, REST 원리를 따르는 시스템은 RESTful이란 용어로 지칭된다.

🪐 RESTful의 목적

• 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것
• RESTful한 API를 구현하는 근본적인 목적이 성능 향상에 있는 것이 아니라 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이 주 동기이니, 성능이 중요한 상황에서는 굳이 RESTful한 API를 구현할 필요는 없다.
• RESTful 하지 못한 경우
  Ex1) CRUD 기능을 모두 POST로만 처리하는 API
  Ex2) route에 resource, id 외의 정보가 들어가는 경우(/students/updateName)

---

🚗 RESTful API

• 정의
  • API 시스템을 구현하기 위한 아키텍처 중에 가장 널리 사용되는 형식(규칙, rule)
  • 웹상에서 사용되는 여러 리소스를 HTTP URI로 표현하고, 그 리소스에 대한 행위를 HTTP Method로 정의하는 방식.
  • 즉, "HTTP URI로 정의된 리소스를 어떻게 한다(HTTP Method + Payload)"를 구조적으로 표현.

---

🚖 RESTful API 설계 규칙

1) URI 정보를 명확하게 표현해야 한다.

• resource는 명사를 사용한다.
  (❗동사는 절대 사용하지 않는다 👉 HTTP Method에만 동사 사용)
  ex) GET /user /1
  ex) GET /users /1

2) resource에 대한 행위(동사)를 HTTP Method(GET, POST, PUT, DELETE)로 표현한다.

• URI에 HTTP Method가 포함되서는 안된다.
  ex) GET delete /user /1 (❌)
  ex) DELETE /user /1 (⭕)

• URI에 동사가 포함되서는 안된다.
  ex) GET /user /show /1 (❌)
  ex) GET /user /1 (⭕)

  ex) POST insert /user /2 (❌)
  ex) POST /user /2 (⭕)

3) resource 사이에 연관 관계가 있는 경우 /(슬래시)로 붙여나간다 (계층관계)

• /리소스 /고유id /관계 있는 리소스
  ex) GET /user /{user_id} /profile
  ex) GET /user /1 /profile
  (user의 id는 1이고, 그의 profile을 가져오고 싶을 때)
  ex) GET /user /1 /profile/2
  (user의 id는 1이고, 그의 profile 중 2번 profile을 가져오고 싶을 때)
  ❗ URI 마지막 문자 뒤에는 /를 포함하지 않는다.

4) 파일의 경우, payload의 포맷을 나타내기 위한 파일 확장자를 URI에 포함시키지 않는다.

ex) GET user/1/profile-photo.jpg (❌)
ex) GET user/1/profile-photo (⭕)

---

🚖 Status Code

200 OK / [SUCCESS]
👉 GET(리소스반환), PUT & PATCH(상태 메시지 또는 리소스 반환)
201 Created / [SUCCESS]
👉 POST(상태메시지 또는 새로 생성된 리소스 반환)
204 No Content / [SUCCESS]
👉 DELETE(성공적으로 삭제된 요청의 응답)
400 Bad Request / [FAILURE]
👉 All(요청에 잘못된 값들이 포함됨 - 전화번호에 글자가 포함된 경우)
401 Unauthorized / [FAILURE]
👉 ALL(인증을 요청 했으나 사용자가 인증 요건을 충족하지 못함 - 로그인이 필요한 경우)
403 Forbidden / [FAILURE]
👉 ALL(사용자가 허용되지 않은 콘텐츠로 접근을 시도함 - 비용을 지불한 사용자가 아닌 경우)
404 Not Found / [FAILURE]
👉 ALL(리소스 없음)
405 Method Not Allowed / [FAILURE]
👉 ALL(허가되지 않은 HTTP Method로 시도됨)
500
👉 서버측 오류

https://brainbackdoor.tistory.com/53