[Network] REST와 RESTful

REST와 RESTful

• 웹에 존재하는 사진, 영상, DB 자원 등 모든 자원에게 고유한 URI를 부여해 GET, POST, DELETE, PUT 명령어를 이용해 활용하는 것을 의미합니다.

 

Rest API의 네 가지 기능과 특징에 대해 말씀해주세요.

• GET : GET를 통해 해당 리소스를 조회하고 요청에 대한 자세한 정보를 가져옵니다
• POST : POST를 통해 해당 URI를 요청하면 리소스를 생성합니다
• DELETE : DELETE를 통해 리소스를 삭제합니다
• PUT : PUT를 통해 해당 리소스를 수정합니다. 여러 번 수행해도 결과가 같은 경우 사용합니다

 

URL과 URI의 차이

• URI는 인터넷 상의 자원을 식별하기 위한 문자열의 구성입니다. URL은 인터넷 상의 자원 위치를 나타내며 URI에 포함되는 개념입니다.

 

REST 란?

• Representational State Transfer(대표적인 상태 전달)
• 월드 와이드 웹(WWW)과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 개발 아키텍쳐의 한 형식
• REST는 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍쳐 스타일
• REST는 네트워크 상에서 Client와 Server가 통신하는 방식 중 하나입니다.
• HTTP URI를 통해 자원을 명시하고, HTTP 메소드를 통해 해당 자원에 대한 CRUD Operation(Create, Read, Update, Delete)을 적용하는 것을 의미합니다.
• 즉, REST는 자원 기반 구조 설계의 중심에 Resource가 있고 HTTP 메소드를 통해 Resource를 처리하도록 설계된 아키텍쳐입니다.
• 웹 사이트의 이미지, DB, 텍스트 내용 등의 모든 자원에 고유한 ID인 HTTP URI를 부여합니다.
• 장점
  1. 여러 가지 서비스 디자인에서 생길 수 있는 문제를 최소화해줍니다.
  2. Hypermedia API의 기본을 충실히 지키면서 범용성을 보장합니다
  3. HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해줍니다.
• 단점
  1. 브라우저를 통해 테스트 할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 헤더 값이 더 어렵게 느껴질 수 있습니다.
  2. 구형 브라우저가 아직 제대로 지원해주지 않는 부분이 존재합니다. (PUT, DELETE를 사용하지 못함)
• REST가 필요한 이유
  1. 애플리케이션 분리 및 통합
  2. 다양한 클라이언트의 등장
  3. 즉, 최근의 서버 프로그램은 다양한 브라우저와 안드로이드, 아이폰과 같은 모바일 디바이스에서도 통신을 할 수 있어야 함
• REST 구성 요소
  1. 자원(Resource) : URI
     • 모든 자원에 고유한 ID가 존재하고, 이 자원은 서버에 존재합니다.
     • 자원을 구별하는 아이디는 'groups/:group_id'와 같은 HTTP URI 입니다.
     • Client는 URI를 통해 자원을 지정하고 해당 자원 상태에 대한 조작을 서버에 요청합니다.
  2. 행위(Verb) : HTTP 메소드
     • HTTP 프로토콜은 메소드를 사용합니다.
     • HTTP 프로토콜은 POST, GET, PUT, DELETE, HEAD와 같은 메소드를 제공합니다.
  3. 표현(Representation Of Resource)
     • Client가 자원 상태에 대한 조작을 서버에 요청하면 서버는 요청에 대한 적절한 응답을 보냅니다.
     • REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 표현으로 나타낼 수 있습니다.
     • JSON 혹은 XML을 통해 자원을 주고받는 것이 일반적입니다.
• REST 특징
  • Server-Client구조
  • Stateless (무상태)
  • Cacheable (캐시 처리 가능)
  • Layered System (계층화)
  • Code-On-Demand (optional)
  • Uniform interface (인터페이스 일관성)

 

 

RESTful 이란?

• 개념
  • RESTful이란 일반적으로 REST란 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어입니다.
  • 즉, REST 원리를 따르는 시스템은 RESTful이란 용어로 지칭된다. RESTful이란 REST를 REST답게 쓰기 위한 방법으로 누군가가 공식적으로 발표한 것은 아닙니다.
• 목적
  • 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것
  • RESTful API를 구현하는 근본적인 목적이 퍼포먼스 향상에 있는게 아니라, 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높여주는게 주 동기입니다. 그렇기때문에 퍼포먼스가 중요한 상황에서 굳이 REST API를 구현할 필요는 없습니다.
• RESTful하지 못한 경우
  • Ex1) CRUD 기능을 모두 POST로 처리하는 API
  • Ex2) route에 resource, id 외의 정보가 들어가는 경우(/students/updateName)

 

 

REST API

• REST기반으로 API를 구현하는 것
• 최근 OpenAPI(누구나 사용할 수 있도록 공개된 API : 네이버 맵, 공공데이터 등등), 마이크로 서비스(하나의 큰 애플리케이션을 여러개의 작은 애플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍쳐) 등을 제공하는 업체 대부분은 REST API를 제공합니다.
• 특징
  • 사내 시스템들도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있습니다.
  • REST는 HTTP 표준을 기반으로 구현하므로 HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현할 수 있습니다.
  • 즉, REST API를 제작하면 델파이 클라이언트 뿐 아니라 자바, C#, 웹 등을 이용해 클라이언트를 제작할 수 있습니다.
• 설계 (기본 규칙)
  1. URI는 정보의 자원을 표현해야 합니다.
     • resource는 동사보다 명사를 사용합니다.
     • resource는 영어 소문자 복수형을 사용하여 표현합니다.
     • Ex) 'GET /Member/1' -> 'GET /member/1'
  2. 자원에 대한 행위는 HTTP 메소드로 표현합니다.
     • URI에 HTTP 메소드가 들어가면 안됩니다.
     • Ex) 'GET /members/delete/1' -> 'DELETE /members/1'
     • URI에 행위에 대한 동사 표현이 들어가면 안됩니다.
     • Ex) 'GET /members/show/1' -> 'GET /members/1'
     • Ex) 'GET /members/insert/1' -> 'POST /members/1'
• 설계 규칙
  1. 슬래시 구분자(/)는 계층 관계를 나타내는데 사용합니다.
     • Ex) 'http://restapi.example.com/houses/apartments'
  2. URI에 마지막 문자로 구분자(/)를 포함하지 않습니다.
     • URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야함
     • Ex) 'http://restapi.example.com/houses/apartments/ (X)'
     • REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않음
  3. 하이픈(-)은 URI가독성을 높이는데 사용합니다.
     • 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높임
  4. 밑줄(_)은 URI에 사용하지 않습니다.
     • 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않음
  5. URI 경로에는 소문자가 적합합니다.
     • URI 경로에 대문자 사용은 피하도록 함
     • RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문
  6. 파일확장자는 URI에 포함하지 않습니다.
     • REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않음
     • 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)`
     • Accept header를 사용
  7. 리소스 간에는 연관관계가 있는 경우
     • /리소스명/리소스 ID/관계가 있는 다른 리소스명
     • Ex) `GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)`
  8. :id는 특정 resource를 나타내는 고유 값
     • Ex) student를 생성하는 route: POST /students 
     • Ex) id=12인 student를 삭제하는 route: DELETE /students/12
•