[ Node.js 입문주차2 (2-0)] REST API, RESTful

RESTful

REST(REpresentational State Transfer)는 Web, 컴퓨터 시스템 간에 표준을 제공하여 시스템이 서로 더 쉽게 통신할 수 있도록 하는 아키텍처 스타일이다. RESTful 시스템이라고도 불리는 REST 호환 시스템은 상태 비저장(stateless)이며 클라이언트와 서버의 문제를 분리하는 방식이 특징이다.

 

이미지 : https://www.codecademy.com/article/what-is-rest

참고 URL : https://www.codecademy.com/article/what-is-rest

What is REST? | Codecademy

 

---

▪︎ RESTful API는 어떻게 작동할까?

RESTful API의 기본 기능은 인터넷 브라우징과 동일하다. 클라이언트는 리소스가 필요할 때 API를 사용하여 서버에 접속. API 개발자는 서버 애플리케이션 API 문서에서 클라이언트가 REST API를 어떻게 사용해야 하는지 설명한다. 다음은 모든 REST API 호출에 대한 일반 단계이다.

 

1. 클라이언트가

2. 서버가 클라이언트를 인증하고 해당 요청을 수행할 수 있는 권한이 클라이언트에 있는지 확인한다.

3. 서버가 요청을 수신하고 내부적으로 처리한다.

4. 서버가 클라이언트에 응답을 반환합니다. 응답에는 요청이 성공했는지 여부를 클라이언트에 알려주는 정보가 포함됩니다. 응답에는 클라이언트가 요청한 모든 정보도 포함된다.

(*REST API 요청 및 응답 세부 정보는 API 개발자가 API를 설계하는 방식에 따라 약간씩 다를 수 있다)

 

▪︎ RESTful API 클라이언트 요청에는 무엇이 포함되어 있을까?
RESTful API에는 다음과 같은 주요 구성요소를 포함하는 요청이 필요하다.

고유 리소스 식별자
서버는 고유한 리소스 식별자로 각 리소스를 식별한다. REST 서비스의 경우 서버는 일반적으로 URL(Uniform Resource Locator)을 사용하여 리소스 식별을 수행한다. URL은 리소스에 대한 경로를 지정. URL은 웹페이지를 방문하기 위해 브라우저에 입력하는 웹 사이트 주소와 유사하다. URL은 요청 엔드포인트라고도 하며 클라이언트가 요구하는 사항을 서버에 명확하게 지정한다.

메서드
개발자는 종종 Hypertext Transfer Protocol(HTTP)을 사용하여 RESTful API를 구현한다. HTTP 메서드는 리소스에 수행해야 하는 작업을 서버에 알려준다. 다음은 4가지의 일반적인 HTTP 메서드.

     1) GET
클라이언트는 GET을 사용하여 서버의 지정된 URL에 있는 리소스에 액세스한다. GET 요청을 캐싱하고 RESTful API 요청에 파라미터를 넣어 전송하여 전송 전에 데이터를 필터링하도록 서버에 지시할 수 있다.
    2) POST
클라이언트는 POST를 사용하여 서버에 데이터를 전송한다. 여기에는 요청과 함께 데이터 표현이 포함된다. 동일한 POST 요청을 여러 번 전송하면 동일한 리소스를 여러 번 생성하는 부작용이 있다.
   3) PUT
클라이언트는 PUT을 사용하여 서버의 기존 리소스를 업데이트한다. POST와 달리, RESTful 웹 서비스에서 동일한 PUT 요청을 여러 번 전송해도 결과는 동일하다.
   4) DELETE
클라이언트는 DELETE 요청을 사용하여 리소스를 제거한다. DELETE 요청은 서버 상태를 변경할 수 있다. 하지만 사용자에게 적절한 인증이 없으면 요청은 실패한다.

HTTP 헤더
요청 헤더는 클라이언트와 서버 간에 교환되는 메타데이터. 예를 들어, 요청 헤더는 요청 및 응답의 형식을 나타내고 요청 상태 등에 대한 정보를 제공한다.

데이터
REST API 요청에는 POST, PUT 및 기타 HTTP 메서드가 성공적으로 작동하기 위한 데이터가 포함될 수 있다.

파라미터
RESTful API 요청에는 수행해야 할 작업에 대한 자세한 정보를 서버에 제공하는 파라미터가 포함될 수 있다. 다음은 몇 가지 파라미터 유형.

URL 세부정보를 지정하는 경로 파라미터.
리소스에 대한 추가 정보를 요청하는 쿼리 파라미터.
클라이언트를 빠르게 인증하는 쿠키 파라미터.

 

▪︎ 그래서, RESTful API를 사용하면 어떤 장점이 있을까?

확장성
REST API를 구현하는 시스템은 REST가 클라이언트-서버 상호 작용을 최적화하기 때문에 효율적으로 크기 조정할 수 있다. 무상태는 서버가 과거 클라이언트 요청 정보를 유지할 필요가 없기 때문에 서버 로드를 제거한다. 잘 관리된 캐싱은 일부 클라이언트-서버 상호 작용을 부분적으로 또는 완전히 제거한다. 이러한 모든 기능은 성능을 저하시키는 통신 병목 현상을 일으키지 않으면서 확장성을 지원한다.

유연성
RESTful 웹 서비스는 완전한 클라이언트-서버 분리를 지원한다. 각 부분이 독립적으로 발전할 수 있도록 다양한 서버 구성 요소를 단순화하고 분리한다. 서버 애플리케이션의 플랫폼 또는 기술 변경은 클라이언트 애플리케이션에 영향을 주지 않는다. 애플리케이션 함수를 계층화하는 기능은 유연성을 더욱 향상한다. 예를 들어, 개발자는 애플리케이션 로직을 다시 작성하지 않고도 데이터베이스 계층을 변경할 수 있다.

독립성
REST API는 사용되는 기술과 독립적이다. API 설계에 영향을 주지 않고 다양한 프로그래밍 언어로 클라이언트 및 서버 애플리케이션을 모두 작성할 수 있다. 또한 통신에 영향을 주지 않고 양쪽의 기본 기술을 변경할 수 있다.

 

 

관련 URL : RESTful API란 무엇인가요? - RESTful API 설명 - AWS (amazon.com)

RESTful API란 무엇인가요? - RESTful API 설명 - AWS

 

 

---

이론적인 부분은 위에서 모두 보았으나, 내용이 잘 정리되지않았다.

아래  youtube를 보니 RESTAPI(restful)에 대한 정립이 잘 되어 함께 첨부하고 공부한 내용을 기재해 보았다.

 

YOUTUBE 얄팍한 코딩사전 [ REST API가 뭔가요? ]

 

 

 

"HTTP상 두 노드가 소통하는데 중요한 역할을 담당하는 REST API"

"개발자들 사이에 널리 쓰이는 일종의 “형식”  

 

 

 

 

▪︎ 프론트엔드 웹에서 서버에 데이터를 요청하거나

배달앱에서 서버에 주문을 넣거나 이런 서비스들이 오늘날 널리 사용되는 것이 REST라는 형식의 API이다.

( * 이것은 과거의 soap이란 복잡한 형식을 대체 )

 

▪︎  Rest의 특징은? 각 요청이 어떤 동작이나 정보를 위한 것인지 그 모습의 요청 자체로 추론이 가능하다.

 

만들고자 하는 서비스에서 기능만 중요하게 생각한다면 동작만 하게 만들면 그만이다. 

서비스는 개발자 혼자 만드는 게 아니다!혼자만 알아볼 수 있게 만든다 ? 인계받고, 이 api를 사용해서 다른 제품을 만드는 개발자들은 일하기 힘들어진다.

 

따라서 Restful 하게 만든 api는 요청을 보내는 주소만으로도 대략 이게 뭘 하는 요청인지 파악이 바로 가능하다. 

 

 

 

예를 들어, 학원목록을 발송해 달라는 요청에 

 

http://(도메인)/classes/

주소에 classes 가 붙는다면, 

데이터는 학원의 '반 목록'이 담긴 값이 될 수 있을 것이다. 

 

http://(도메인)/classes/2

그 뒤에 idx, 고유번호가 따라붙으면 인덱스 번호가 '반의 정보'가 될 수 있다.   

 

http://(도메인)/classes/2/students

그 뒤에 students가 붙는다면 '학생의 정보'가,

 

http://(도메인)/classes/2/students/15

그 뒤에 또 idx가 붙는다면 '그 번호를 가진 학생의 정보'를 알 수 있다.

 

 

 

▪︎  이렇게 자원을 구조와 함께 나타내는 구분자의 방식을 URI라고 한다.

( * URI는 Uniform Resource Identifier의 약자로 URI는 인터넷에서 리소스를 식별하는 데 사용되는 문자열이다. )

 

▪︎  이 데이터들은 '조회/삭제/수정'작업도 가능한데 이런 작업을 C.R.U.D라고 한다.

 

Create 생성

Read 조회

Update 수정

Delete 삭제

 

 

▪︎ 만약 학생에 대한 데이터를 수정하려면 서버에 REST API로 요청을 보내는데, http라는 규약에 따라 신호를 전송한다.  

 

Post / put / patch

( 3개는 'body'에 실어서 보내는데, Get / delete에 비해 비교적 안전하게 감춰서 실어 보낼 수 있다.)

Get / delete 

 

 

 

아래의 예시를 보자

URI에 [GET] http://(도메인)/classes/2/students 으로 보내는 요청이 있으면

학생들을 보는 요청이다라는 것을 알 수 있다. (* [Get] 데이터를 read : 데이터를 조회하는 데 사용 )

 

 

반에 새 학생이 들어와서 정보를 추가한다면 [Post] http://(도메인)/classes/2/students 

같이 URI를 짜고 Post 요청을 작성 body에 새 학생의 정보를 넣어 보낸다. (* [Post ] create : 새로운 정보를 추가하는 데 사용한다.)

( 학생의 idx는 정보가 추가되면서 생성됨으로 post요청에는 명기할 필요가 없다. ) 

 

 

idx를 가진 학생의 정보가 변경되었을 때[PUT]PATCH] http://(도메인)/classes/2/students/15

URI에 변경할 학생의 idx까지 명시한 다음 PUT 또는 patch를 사용해서 변경 또는 Update 된 새 정보들을 body에 넣어서 보낸다.

( * PUT, PATCH 쓰는 곳마다 각각 달라 아래의 특징을 보고사용.) 

( * [PUT]  : 정보를 전체다 변경할 때 

[patch] : 정보 중 일부만 변경할때 )

 

 

학생이 학원을 그만두었다면 URI에 학생의 idx 까지 표시해서 보낸다.  [DELETE]http://(도메인)/classes/2/students/15

(* [DELETE]  : 정보를 삭제할 때 사용한다 )