작은 지식주머니
REST 개념공부 본문
! 개인 공부용 자료입니다. 만약 틀린점이 있다면 댓글로 남겨주신다면 매우 감사하겠습니다.
또한 해당 사이트를 보고 많이 참고했기 떄문에 만약 REST에 대한 개념을 알기 위해서는 밑 사이트를 보시는걸 더 추천합니다.
https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html
[Network] REST란? REST API란? RESTful이란? - Heee's Development Blog
Step by step goes a long way.
gmlwjd9405.github.io
REST란
- "Representational State Transfer"의 약자 소프트웨어 프로그램 개발의 아키텍처 방식중 한 형식
- resource(자원)의 representation(표현)에 의한 상태 전달
- 자원 : 해당 소프트웨어가 관리하는 모든 것
- 문서 , 그림 ,데이터 , 해당 소프트웨어 등
- 자원의 표현: 그 자원을 표현하기 위한 이름
- ex) DB의 게시물 자원을 꺼내올 경우 그 게시물들을 대표하기 위한 이름 ex) data 로 얻음.
- 만약 특정 게시물을 얻고자 한다면 한 게시물을 특정할 수 있는 값 id가 사용됨.
- ex) DB의 게시물 자원을 꺼내올 경우 그 게시물들을 대표하기 위한 이름 ex) data 로 얻음.
- 상태 전달
- 데이터가 요청되면서 자원의 상태를 전달
- JSON or XML을 통해서 데이터를 주고 받는 것이 일반적
- ex) 게시물 전체 리스트를 요청받았다면 요청받은 시점의 게시물 전체 리스트의 상태를 전달
- ex) 새로운 게시물의 상태를 프로그램에 전달하여 해당 자원의 수정이 이루어질 수 있음.
- 자원 : 해당 소프트웨어가 관리하는 모든 것
- resource(자원)의 representation(표현)에 의한 상태 전달
- 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일이다.
- 간단히 설명하면 HTTP를 통해 CRUD를 실행하는 API를 뜻하기도 함.
REST를 구체적으로 설명한다면
- HTTP URL을 통해서 자원을 명시하고 HTTP METHOD(CRUD)를 통해 해당 자원에 대한 CRUD Operation을 적용한 것을 의미
- REST는 자원 기반의 구조(ROA, Resource Oriented Architecture) 설계를 중심으로 Resource가 있고 Http Method를 통해서 Resource를 처리하도록 설계된 아키텍처를 의미함.
- ROA란
- 자원 지향 아키텍쳐라는 뜻으로 RESTful 인터페이스 자원의 형태로 소프트웨어를 설계 및 개발을 위한 소프트웨어 아키텍처와 프로그래밍 패러다임의 스타일. ROA는 REST를 위한 아키텍처라고 보면 됨?
- ROA란
- REST는 자원 기반의 구조(ROA, Resource Oriented Architecture) 설계를 중심으로 Resource가 있고 Http Method를 통해서 Resource를 처리하도록 설계된 아키텍처를 의미함.
REST의 장점
- 정해진 규칙대로 ROUTING 주소를 만들기 떄문에 ROUTE 이름을 짓는 수고를 덜 수 있고 통일성이 있음.
- 예를 들어 학생과 선생을 관리하는 API를 만든다고 가정할 경우
- RESTful 하게 API 주소를 만든다면 "Students" , "teachers" 라는 resource명을 제외한 나머지 API 주소가 동일하게 된다.
- 하지만 RESTful 하게 만들지 않았다면 /createStudent , /createTeacher, 가시성이 좋지 않아지고
양쪽 팀의 API를 동시에 사용하는 프로그램을 만드는 경우 이러한 비일관성은 혼란을 야기함. - API의 확장이 쉽다. 학생 API에서 과목을 관리하는 API를 추가하는 경우
[POST] students/:id/classes, [DELETE] students/:id/classes/:id 처럼 만들 수 있다. - 하지만 RESTful 하게 만들지 않았다면 route 주소 이름을 따로 지어줘야 하기 때문에 가시성, 생산성이 떨어짐
REST의 단점
- 표준이 존재하지 않다.
- 사용할 수 있는 메소드가 4가지 밖에 없다.
- 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 값이 어렵게 느껴짐
- 구형 브라우저가 아직 지원을 제대로 하지 못하는 부분이 존재.
- PUT, DELETE를 사용하지 못함.
- pushState를 지원하지 않음
REST가 필요한 이유
- 애플리케이션 분리 및 통합
- 다양한 클라이언트의 등장
- 다양한 브라우저와 안드로이드, 아이폰과 같은 모바일 디바이스에서도 통신을 할 수 있어야 하기 때문
REST의 구성 요소
- 자원(Resource) : URL
- 모든 자원에 고유한 ID가 존재하며 이 자원은 Server에 존재
- 자원을 구별하는 ID는 "/groups/:groud_id" 같은 HTTP URL이다.
- Client는 URL 을 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청함.
- 행위(Verb) : HTTP Method
- HTTP 프로토콜의 Method를 사용
- HTTP 프로토콜은 GET,POST,PUT,DELETE 와 같은 메서드를 제공
- 표현 (ROA)
- Client가 자원의 상태에 대한 조작을 요청하면 Server는 이에 적절한 응답을 보낸다.
- REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 응답으로 나타날수 있다.
- JSON 혹은 XML을 통해서 데이터를 받는것이 일반적.
REST의 특징
- Server-Client 구조
- 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client
- REST Server: API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다.
- Client: 사용자 인증이나 context(세션, 로그인정보) 등을 직접 관리하고 책임짐.
- 서로 간 의존성이 줄어든다.
- 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client
- Stateless(무상태)
- HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 가지고있다.
- Client의 context를 Server에 저장하지 않는다.
- 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 되므로 구현이 단순해짐.
- Server는 각각의 요청을 완전히 별개의 것으로 인식
- 각 API 서버는 Client의 요청만을 단순 처리.
- 이전 요청이 다음 요청의 처리에 연관되어서는 안됨.
- Server의 처리 방식에 일관성을 부여하고 부담이 줄어들며, 서비스의 자유도가 높아짐
- Cacheable(캐시 처리 가능)
- 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용 가능
- HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용가능.
- HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그와 E-Tag를 이용하여 캐싱 구현가능
- 대량의 요청을 효율적으로 처리하기 위해 캐시가 요구됨.
- 캐시 사용을 통해서 응답시간이 빨라지고 REST Server 트랙잭션이 발생하지 않기 떄문에
전체 응답시간, 성능, 서버의 자원 이용률을 향상 시킬 수 있음.
- 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용 가능
- Layered System(계층화)
- Client는 REST API Server만 호출한다.
- REST Server는 다중 계층을 구성될 수 있다.
- API Server는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화
사용자 인증 등을 추가하여 구조상의 유연성을 줄 수 있다.
- API Server는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화
- PROXY 같은 네트워크 기반의 중간 매체를 사용할 수 있다.
- Code-On-Demand
- Server로부터 스크립트를 받아 Client에서 실행함.
- 반드시 충족할 필요할 필요는 없다.
- Uniform Interface(인터페이스 일관성)
- URL로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행
- HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능
REST API란
- API(Application Programming Interface)
- 데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간 상호작용을 촉진
서로 정보를 교환 가능 하도록 하는 것
- 데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간 상호작용을 촉진
- REST API의 정의
- REST 기반으로 서비스 API를 구현한 것
- 최근 OpenAPI, 마이크로 서비스 등을 제공하는 업체들은 대부분 REST API를 제공
REST API의 특징
- 사내 시스템들도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여
유지보수 및 운용을 편리하게 할 수있다. - REST는 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현 가능
- 즉 REST API를 제작하면 여러 프로그래밍 언어를 이용해 클라이언트 제작이 가능
REST API 설계 기본 규칙
- URI은 정보의 자원을 표현해야한다.
- RESOURCE는 동사보다는 명사, 대문자보다는 소문자를 사용
- RESOURCE의 도큐먼트 이름으로는 단수 명사를 사용해야 한다.
- RESOURCE의 컬렉션 이름으로 복수 명사를 사용해야 한다.
- RESOURCE의 스토어 이름으로는 복수 명사를 사용해야 한다.
- EX) GET /Member/1 X - GET /members/1
- 자원에 대한 행위는 HTTP Method로 표현한다.
- URI에 HTTP METHOD가 들어가서는 안된다.
- URI에 행위에 대한 동사표현이 들어가서는 안된다.
- 경로 부분 중 변하는 부분은 유일한 값으로 대체
REST API 설계 규칙
- 슬래시 구분자는 계층 관계를 나타내는데 사용
- URI 마지막 문자로 슬래시를 포함하지 않는다.
- URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 한다.
- REST API는 분명한 URI를 만들어 통신을 해야하기 떄문에 혼동을 주지 않도록 URI 경로의 마지막에는
슬래시를 사용하지 않는다.
- 하이픈 (-) 은 URI의 가독성을 높이도록 사용
- 밑줄(_)을 URI의 가독성이 좋지 않기 때문에 사용하지 않음
- URI 경로에는 소문자가 적합함.
- 파일확장자는 URI에 포함하지 않는다.
- Accept header를 사용
RESTful 이란
- RESTful은 일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어이다.
- REST API를 제공하는 웹 서비스를 RESTful 하다고 할 수 있다.
RESTful의 목적
- 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것
- RESTful한 API를 구현하는 근본적인 목적이 성능 향상에 있는 것이 아니라
API의 이해도 및 호환성을 높이는 것이 주 이유
References
https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html
https://hckcksrl.medium.com/rest%EB%9E%80-c602c3324196
https://www.a-mean-blog.com/ko/blog/%ED%86%A0%EB%A7%89%EA%B8%80/_/REST%EC%99%80-RESTful-API
https://mygumi.tistory.com/55
https://greatkim91.tistory.com/13
https://hahahoho5915.tistory.com/33
https://milkye.tistory.com/202
https://gangnam-americano.tistory.com/39
'TID (Today I Do)' 카테고리의 다른 글
CRA 없이 직접 React 빌드해보기. (0) | 2023.07.27 |
---|---|
JAVA 기술 면접 대비 (0) | 2022.02.24 |
CORS란? (0) | 2022.01.27 |
spring @Transactional (0) | 2022.01.26 |
Comments