-
[Network] REST, REST API, RESTfulServer/Basic 2020. 11. 16. 16:12
안녕하세요 :)
오늘은 네트워크 기본 개념인 REST에 대해 알아볼게요!
여태까지 iOS 개발을 하고 Spring Boot를 활용해서 개발을 했는데 REST라는 것이 무엇인지 정확하게 모르고 사용하고 있더라구요.
그래서 오늘 정리하려고 합니다!
REST?
서버 개발을 하면서 REST API라는 말을 많이 들어보셨을 텐데요.
REST API에서 REST가 구조를 의미합니다.
REST는 "Representational State Transfer"의 약자입니다.
자원을 이름(표현)으로 구분해 해당 자원의 정보(상태)를 주고 받는 모든 것을 의미합니다.
위의 말이 알듯 말듯 조금 애매하네요!
우선 자원이라는 것은 소프트웨어가 관리하는 모든 것을 의미합니다.
문서, 그림, 데이터 그리고 소프트웨어 자체가 될 수도 있습니다.
자원의 표현은 그 자원을 표현하기 위한 이름입니다.
예를 들어서 작성 글 DB를 posts로 표현하는 것 자체를 의미합니다.
상태를 전달한다는 것은 Client가 Server에게 데이터를 요청하는 시점에 자원의 상태, 즉 정보를 전달합니다.
보통 JSON이나 XML을 통해 데이터를 주고받는 것이 일반적입니다.
이렇게 봤을 때 저희는 한 가지 사실을 알 수 있습니다.
REST는 네트워크 상에서 Client와 Server 사이의 통신 방식 중 하나라는 것입니다.
REST는 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일입니다.
REST는 자원 기반의 구조 (ROA | Resource Oriented Architecture) 입니다.
- ROA (Resource Oriented Architecture)
설계의 중심에 Resource가 있고 HTTP Method를 통해 Resource를 처리하도록 설계된 아키텍처 - HTTP URI를 통해 자원을 명시하고, HTTP Method를 통해 해당 자원에 대한 CRUD Operation (POST, GET, PUT, DELETE) 을 적용합니다.
자원을 명시한다는 것은 웹 사이트의 이미지, 텍스트, DB 내용 등의 모든 자원에 고유한 ID인 HTTP URI를 부여합니다.
REST의 구성 요소
- 자원 Resource : URI
모든 자원에 고유한 ID가 존재하며 이 자원은 Server에 존재합니다.
자원을 구별하는 ID는 /groups/:group_id 와 같은 HTTP URI 입니다.
Client는 URI를 이용해 자원을 지정하고 해당 자원의 상태에 대한 조작을 서버에 요청합니다. - 행위 : HTTP Method
GET, POST, PUT, DELETE 메서드를 활용해 자원의 상태를 조작합니다. - 표현 Representation of Resource
Client가 자원의 상태에 대한 조작을 요청하면 서버는 이것에 대한 적절한 응답 (Representation) 을 보냅니다.
REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타날 수 있습니다.
REST 특징
- Server - Client 구조
REST Server : 자원을 지니고 있음, API를 제공하고 비즈니스 로직 처리 및 저장
Client : 자원을 요청함, 사용자 인증이나 세션, 로그인 정보 등을 직접 관리 - Stateless (무상태)
HTTP 프로토콜은 Stateless 프로토콜이므로 그것을 기반으로 하는 REST 또한 Stateless
Client의 context (세션, 쿠키 등) 를 서버에 저장하지 않음
context 정보를 신경쓰지 않아도 되므로 서버 구현이 단순
각 API 서버는 Client의 요청을 별개로 인식하고 단순히 처리만 합니다.
이전 요청이 다음 요청의 처리와 연관되지 않기 때문에 서버의 처리 방식이 일관적이고 부담이 줄어들어 서비스의 자유도가 높아집니다. - Cacheable (캐시 처리 기능)
HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하던 기존의 인프라를 그대로 활용이 가능합니다. 따라서 캐싱 기능도 적용 가능합니다.
대량의 요청을 효율적으로 처리하기 위해 캐시가 요구됩니다.
캐시 사용을 통해 응답시간이 빨라지고 REST 서버에 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있습니다. - Layered System (계층화)
Client는 REST API 서버만 호출합니다.
REST 서버는 다중 계층으로 구성될 수 있습니다.
API 서버는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 암호화, 사용자 인증 등을 추가하여 유연한 구조를 가질 수 있습니다. - Uniform Interface (인터페이스 일관성)
URI로 지정한 자원에 대한 조작을 통일되고 한정적인 인터페이스로 수행합니다.
특정 언어나 기술에 종속되지 않아 HTTP 표준 프로토콜을 따르는 모든 플랫폼에서 사용 가능합니다
REST가 필요한 이유
REST는 애플리케이션을 분리 및 통합합니다.
오늘날 다양한 클라이언트가 등장하면서 서버는 다양한 브라우저와 모바일 디바이스 등 멀티 플랫폼을 지원해야 했습니다.
멀티 플랫폼에 대한 지원을 위해서 서비스 자원에 대한 아키텍처를 세우고 이용하는 방법이 REST 입니다.
아주 오래된 플랫폼 외의 모든 플랫폼은 보통 HTTP 프로토콜을 따르므로 거의 모든 플랫폼에서 사용이 가능할 것입니다.
REST API?
우선 API가 무엇일까요?
API는 Application Programming Interface의 약자로, 데이터와 기능의 집합을 제공하여 프로그램간의 상호작용을 촉진하며 서로 정보 교환도 가능하도록 하는 것입니다.
그렇다면 REST API는 무엇일까요?
단순하게 REST를 기반으로 서비스 API를 구현한 것이라고 할 수 있겠죠?
하나의 예로 사내 시스템들을 REST 기반으로 구축한다면 시스템을 분산해 확장성과 재사용성을 높일 수 있을 것이고, 유지보수 및 운용을 편리하게 할 수 있을 것입니다.
REST API 설계 기본 규칙
REST API를 설계할 때 몇 가지 규칙이 있습니다.
무조건 이렇게 해야한다!는 아니지만 그래도 최대한 지키는 방향으로 서버를 구현하면 좋겠죠?
- URI는 정보의 자원을 표현해야 합니다.
resource : 명사, 소문자
resource document : 단수 명사
resource collection : 복수 명사
resource store : 복수 명사
(GET /Member/1 -> GET /members/1) - 자원에 대한 행위는 HTTP Method로 표현합니다.
URI에 HTTP Method가 들어가면 안되고, 행위에 대한 동사가 들어가면 안됩니다.
URI 경로 부분 중 변할 수 있는 부분은 유일한 값으로 대체하는 것이 좋습니다.
(GET members/show/1 -> GET /members/1)
(student 생성 : POST /students, id=12인 student 삭제 : DELETE /students/12) - 기타 규칙들
슬래시 구분자(/)는 계층 관계를 나타낼 때 사용합니다.
URI 마지막 문자로 슬래시를 포함하지 않습니다.
하이픈 문자(-)는 URI의 가독성을 높이는 데 종종 사용하지만, 밑줄 문자(_)는 URI에 사용하지 않습니다.
URI 경로는 소문자를 사용하고, 파일 확장자는 URI에 포함하지 않습니다.
자원 간의 연관 관계가 있는 경우에는 /리소스명/리소스ID/관계가 있는 다른 리소스명 으로 구현합니다.
설계 예시
CRUD HTTP Method Route resource 목록 표시 GET /resource resource 하나의 내용 표시 GET /resource/:id resource 생성 POST /resource resource 수정 PUT /resource/:id resource 삭제 DELETE /resource/:id 응답 상태 코드
- 1xx : 전송 프로토콜 수준의 정보 교환
- 2xx : Client 요청을 성공적으로 수행
- 3xx : Client가 요청 완료를 위해 추가적인 행동을 취해야 함
- 4xx : Client의 잘못된 요청
- 5xx : Server 오류
RESTful?
RESTful은 일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어입니다.
REST API를 제공하는 웹 서비스는 RESTful하다고 말할 수 있겠죠?
RESTful은 REST를 REST답게 쓰기 위한 방법으로, 공식적으로 발표된 개념은 아닙니다.
단지 REST의 원리를 따르는 시스템은 RESTful이라는 용어로 지칭됩니다.
RESTful 목적
- 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것
- RESTful한 API를 구현하는 근본적인 목적은 성능 향상이 아니고 일관적인 컨벤션을 통한 API의 이해도와 호환성을 향상하는 것이 주 목적
RESTful하지 못한 경우
- CRUD 기능을 모두 POST로만 처리하는 API
- route에 resource, id 외의 정보가 들어가는 경우
마무리
이번 기회에 REST, REST API, RESTful에 대해서 쭉 정리하면서 지키지 못한 규칙들이 많았다는 것을 깨달았습니다.
얼른 유지보수하러 가봐야겠어요 :)
오늘도 포스팅 읽어주셔서 감사합니다!
- ROA (Resource Oriented Architecture)