REST
REST 정의
Representational State Transfer의 약자이다.
- Rest는 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일이다.
- REST는 네트워크 상에서 Client와 Server 사이의 통신 방식 중 하나이다.
- 자원(resource)의 표현(representation)
- 자원 : 해당 소프트웨어가 관리하는 모든 것
- -> ex) 문서, 그림, 데이터, 해당 소프트웨어 자체 등
- 자원의 표현 : 그 자원을 표현하기 위한 이름
- -> ex) DB의 게시글 정보가 자원일 때, 'post'를 자원의 표현으로 정한다.
- 상태(정보) 전달
- 데이터가 요청되어지는 시점에서 자원의 상태(정보)를 전달한다.
- JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.
REST 구체적 개념
HTTP URI를 통해 자원을 명시하고, HTTP Method를 통해 해당 자원에 대한CRUD Operation을 적용하는 것을 의미한다
즉, REST는 자원 기반의 구조 설계의 중심에 Resource가 있고 HTTP Method를 통해 Resource를 처리하도록 설계된 아키텍처를 의미한다.
- CRUD Operation
- Create : 생성(POST)
- Read : 조회(GET)
- Update : 수정(PUT,PATCH)
- Delete: 삭제(DELETE)
- HEAD : header 정보 조회(HEAD)
REST의 장단점
장점
- HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구축할 필요가 없다.
- HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해준다.
- HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
- REST API 메세지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.
- 여러가지 서비스 디자인에서 생길 수 있는 문제를 최소화 한다.
- 서버와 클라이언트의 역할을 명확하게 분리한다.
단점
- 표준이 존재하지 않는다.
- 사용할 수 있는 메서드가 4가지 밖에 없어서 제한적이다.
- 구형 브라우저를 제대로 지원해주지 못하는 부분이 존재한다.
REST의 구성
- 자원 - URI
- 행위 - HTTP Method
- 표현 (Representations of Resource)
자원 (Resource) URI
- 모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
- 자원을 구별하는 ID는 '/posts/:post_id' 와 같은 HTTP URI이다.
- Client는 URI를 이용하여 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다.
행위 - HTTP Method
- HTTP 프로토콜의 Method를 사용한다.
- HTTP 프로토콜은 GET, POST, PUT, DELETE와 같은 메서드를 제공한다.
표현 (Respresentations of Resource)
- Client가 자원의 상태에 대한 조작을 요청하면 Server는 이에 적절한 응답을 보낸다.
- REST에서 하나의 자원은 JSON, XML, TEXT 등 여러 형태의 표현으로 나타내어 질 수 있다.
- JSON 혹은 XML을 통해 데이터를 주고 받는 것이 일반적이다.
REST 특징
1. Server-Client
- 자원이 있는 쪽이 Server, 요청하는 쪽이 Client가된다.
- REST Server : API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다.
- Client : 사용자 인증이나 세션, 로그인 정보등을 직접 관리하고 책임진다.
- 서로간의 의존성이 줄어든다.
2. Stateless(무상태)
- HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 갖는다.
- 서버에서 어떤 작업을 하기 위해 상태정보를 기억할 필요가 없고 들어온 요청에 대한 단순 처리만 해주면 되기 때문에 구현이 쉽고 단순해진다.
3. Cacheable(캐시 처리 가능)
- 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용 가능하다
- 대량의 요청을 효율적으로 처리하기 위해 캐시가 요구된다.
- 캐시 사용을 통해 응답시간이 빨라지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있다.
4. Layered System(계층화)
- 클라이언트와 서버가 분리되어 있기 때문에 비즈니스 로직을 수행하는 앞단에 암호화, 사용자 인증 등을 추가하여 구조상의 유연성을 줄 수 있다.
- 프록시, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있다.
5. Uniform Interface (인터페이스 일관성)
- URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.
- HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
REST API
REST 기반으로 서비스 API를 구현한 것이다.
API
내가 만든 서비스가 개인, 기업, 기관이 제공하는 기능 및 프로그램을 사용할 수 있도록 도와주는 중간 매개체를 뜻한다.
최근 OpenAPI(누구나 사용할 수 있도록 공개된 API), 마이크로 서비스(하나의 큰 애플리케이션을 여러 개의 작은 애플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍쳐) 등을 제공하는 업체 대부분은 REST API를 제공한다.
기본 규칙
- URI는 정보의 자원을 표현해야한다.
- 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE등)로 표현한다.
세부 규칙
- 슬래시 구분자( / )는 계층 관계를 나타내는데 사용한다.
- URI 마지막 문자로 슬래시( / )를 포함하지 않는다.
- URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것
- 역으로 리소스가 다르면 URI도 달라져야한다.
- 하이픈 ( - )은 URI 가독성을 높이는데 사용한다.
- 밑줄 ( _ ) 은 URI에 사용하지 않는다.
- URI 경로에는 소문자가 적합하다.
- 대문자 사용은 피하도록한다.
- 파일 확장자는 URI에 포함하지 않는다.
- Accept header를 사용한다.
- 리소스 간에 연관 관계가 있는 경우
- /리소스명/리소스ID/관계가 있는 다른 리소스명
RESTful
- HTTP와 URI 기반으로 자원에 접근할 수 있도록 제공하는 애플리케이션 개발 인터페이스이다.
- REST API를 제공하는 웹 서비스를 RESTful 하다고 한다.
- 즉, REST 원리를 따르는 시스템은 RESTful이란 용어로 지칭된다.
RESTful 하다
- 자원을 식별할 수 있어야한다.
- 행위는 명시적이어야 한다.
- 자기 서술적이어야 한다.
RESTful 하지 못한 경우
- CRUD 기능을 모두 POST로 처리하는 API
- route에 resource, id 외의 정보가 들어가는 경우
평소에도 RESTful한 개발은 무엇일까라는 생각을 종종 했었는데 이번에 팀 프로젝트를 진행하며, 튜터님께서 한번 REST에 대하여 공부를 해보는게 어떻겠냐는 말을 하셔서 이번에 REST에 대하여 찾아보고 블로그에 정리하는 시간을 가졌다.
물론 블로그에 정리했다고해서 온전히 나의것이 된건 아니지만 RESTful하다 에 대한 내생각을 말해보자면 자원과 행위를 통해 이것이 어떤 행동을하는 API인지 말로 설명하지 않아도 알 수 있도록 하는 것이 RESTful하다고 할 수 있을 것 같다.
'TIL' 카테고리의 다른 글
Todo 프로젝트 리팩토링 하기 (0) | 2024.10.30 |
---|---|
뉴스피드 프로젝트 리팩토링 (1) | 2024.10.25 |
JPA - 일정관리 앱 만들기 (1) | 2024.10.17 |
JPA - 회원가입 로그인 (0) | 2024.10.17 |
JPA - JWT와 필터 구현하기 (1) | 2024.10.16 |