[학습내용]
REST
(Representational State Transfer : 자원의 상태 전달) - 네트워크 아키텍처이다.
주소에는 명사, 요청 방식에는 동사를 사용함으로써 의도를 명확히 드러냄.
생성(post)
조회(get)
수정(put)
삭제(delete)
- GET /courses
→ 강의 전체 목록 조회 요청 - GET /courses/1
→ ID가 1번인 녀석 조회 요청 - POST /courses
→ 강의 생성 요청 - PUT /courses/3
→ ID가 3번인 녀석 수정 요청 - DELETE /courses/2
→ ID 2번인 녀석 삭제 요청
/account/edit 말고 /account/put 처럼.
주소에 동사는 가급적 사용하지 않음.
URI (Uniform Resource Identifier)
- 인터넷 자원을 나타내는 고유 식별자
- 즉, 인터넷에 있는 자료의 ID 이다.
- 다른 자료가 똑같은 이름을 가지고 있으면 안되므로 URI는 유일해야함.
ex) www.naver.com 을 검색하면 반드시 네이버가 나와야 하며 다른 사이트가 나오면 안됨.
또, www.naver.com/movies/181 을 검색하면 181번 영화가 나와야지 7번 영화가 나오면 안됨.
URL (Uniformed Resource Locator)
- 프로토콜 포함
- 해당 자원의 위치, 경로를 의미
- 일반적으로 사이트 도메인을 자주 의미함.
- 웹 상 뿐만 아니라 컴퓨터 네트워크상의 자원은 모두 나타낼 수 있다.
URN (Uniformed Resource Name)
- 프로토콜 포함 X
- 해당 자원의 이름을 의미
- 독립적인 자원 지시자
- Page 이후 부분까지 포함
API
클라이언트와 - 서버 간의 약속 (클라이언트와 서버가 서로 상호작용하는 창구)
각각 용도에 맞게 정해진 요구를 날리면 정해준 웹을 돌려주는 그 약속의 창구를 API라고 함.
클라이언트가 정한대로 서버에게 요청(Request)을 보내면,
서버가 요구사항을 처리하여 응답(Response)을 반환.
요청의 종류의 따라 여러가지 API가 있음.
- 데이터를 생성하는 요청을 하면 은행으로 치면 대출창구
- 조회하면, 예금창구.
REST API & URl 설계원칙
- REST(REpresentational State Transfer)란?
REST의 정의
"REpresentational State Transfer" 의 약자로,
자원을 이름(자원의 표현)으로 구분해 해당 자원의 상태(정보)를 주고 받는 모든 것을 의미.
즉, 자원(resource)의 표현(representation)에 의한 상태 전달.
- 자원 : 해당 소프트웨어가 관리하는 모든 것 ( 문서, 그림, 데이터, 해당 소프트웨어 자체 등 )
- 표현 : 그 자원을 표현하기 위한 이름 ( DB의 학생 정보가 자원이면, 'students'를 자원의 표현으로 정함 )
- 상태 전달 : 데이터가 요청되는 시점에 자원의 상태를 전달한다. ( JSON 혹은 XML을 통해 데이터를 주고 받는 것이 일반적 )
REST는 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에,
웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일임.
즉, REST는 네트워크 상에서 Client와 Server 사이의 통신 방식 중 하나임.
REST의 개념
어떤 자원에 대해 CRUD(Create, Read, Update, Delete) 연산을 수행하기 위해 URI(Resource)로
GET, POST 등의 방식(Method)을 사용하여 요청을 보내며, 요청을 위한 자원은 특정한 형태(Representation of Resource)로 표현됨.
REST의 구성 요소
1. 자원(Resource) - URI
- 모든 자원에는 고유한 ID가 존재하고, 이 자원은 Server에 존재.
- 자원을 구별하는 ID는 '/exgroups/:exgroup_id'와 같은 HTTP URI임.
- Client는 URI를 이용해 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청함.
2. 행위(Verb) - Method
- HTTP 프로토콜의 Method를 사용.
- HTTP 프로토콜은 GET, POST, PUT, PATCH, DELETE의 Method를 제공. ( CRUD )
3. 표현 ( Representation of Resource )
- Client와 Server가 데이터를 주고받는 형태로 JSON, XML, TEXT, RSS 등이 있음.
- JSON, XML을 통해 데이터를 주고 받는 것이 일반적.
REST의 특징
1. Server-Client (서버-클라이언트 구조)
- 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client
- REST Server는 API를 제공하고 비즈니스 로직 처리 및 저장을 책임지고,
- Client는 사용자 인증이나 context( 세션, 로그인 정보 ) 등을 직접 관리하고 책임.
- 역할을 확실히 구분시킴으로써 서로 간의 의존성을 줄임.
2. Stateless (무상태)
- HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 갖는다.
- Client의 context를 Server에 저장하지 않음.
- 즉, 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 되므로 구현이 단순해짐.
- Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리함.
- 각 API 서버는 Client의 요청만을 단순 처리.
- 즉, 이전 요청이 다음 요청의 처리에 연관되어서는 ❌. ( DB에 의해 바뀌는 것은 허용 )
- Server의 처리 방식에 일관성을 부여하기 때문에 서비스의 자유도가 높아짐.
3. Cacheable (캐시 처리 기능)
- 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용.
- 즉, HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용.
- HTTP 프로토콜 표준에서 사용하는 Last-Modified Tag 또는 E-Tag를 이용해 캐싱을 구현.
- 대량의 요청을 효율적으로 처리.
4. Layered System (계층 구조)
- Client는 REST API Server만 호출.
- REST Server는 다중 계층으로 구성.
- 보안, 로드 밸런싱, 암호화 등을 위한 계층을 추가하여 구조를 변경할 수 있음.
- Proxy, Gateway와 같은 네트워크 기반의 중간매체를 사용.
- 하지만 Client는 Server와 직접 통신하는지, 중간 서버와 통신하는지는 알 수 없음.
5. Uniform Interface (인터페이스 일관성)
- URI로 지정한 Resource에 대한 요청을 통일되고, 한정적으로 수행하는 아키텍처 스타일을 의미.
- HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하며, Loosely Coupling(느슨한 결함) 형태.
- 즉, 특정 언어나 기술에 종속되지 않음
6. Self-Descriptiveness (자체 표현)
- 요청 메시지만 보고도 쉽게 이해할 수 있는 자체 표현 구조로 되어있음.
REST API 란?
REST API의 정의
- REST의 특징을 기반으로 서비스 API를 구현한 것
- 최근 OpenAPI(누구나 사용할 수 있도록 공개된 API: 구글 맵, 공공 데이터 등), 마이크로 서비스(하나의 큰 어플리케이션을 여러 개의 작은 어플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍처) 등을 제공하는 기업 대부분은 REST API를 제공.
REST API의 특징
- 가장 큰 특징은 각 요청이 어떤 동작이나 정보를 위한 것인지를 그 요청의 모습 자체로 추론이 가능한.
REST API 디자인 가이드
REST API 설계 시 가장 중요한 항목은 다음의 2가지로 요약.
- 첫 번째, URI는 정보의 자원을 표현해야 함.
- 두 번째, 자원에 대한 행위는 HTTP Method(GET, POST, PUT, PATCH, DELETE)로 표현.
- 행위(Method)는 URI에 포함하지 않음.
REST API의 설계 규칙
1. URI는 명사를 사용한다.(리소스명은 동사가 아닌 명사를 사용.)
1-1. 아래와 같은 동사를 사용하지 말 것
- /getAllUsers
- /getUserById
- /createNewUser
- /updateUser
- /deleteUser
2. 슬래시( / )로 계층 관계를 표현한다.
3. URI 마지막 문자로 슬래시 ( / )를 포함하지 않는다.
4. 밑줄( _ )을 사용하지 않고, 하이픈( - )을 사용한다.
5. URI는 소문자로만 구성한다.
6. HTTP 응답 상태 코드 사용
- 클라이언트는 해당 요청에 대한 실패, 처리완료 또는 잘못된 요청 등에 대한 피드백을 받아야 한다.
7. 파일확장자는 URI에 포함하지 않는다.
Ex) http://dev-coco.tistory.com/restapi/220/photo.jpg (X)
그래서 REST API와 RESTful API의 차이는 뭘까?
RESTful은 REST의 설계 규칙을 잘 지켜서 설계된 API를 RESTful한 API라고 함.
즉, REST의 원리를 잘 따르는 시스템을 RESTful이란 용어로 지칭.
RESTful하게 만든 API는 요청을 보내는 주소만으로도 어떤 것을 요청 하는지 파악이 가능.
예를들어, https://school.com/grade 의 주소는 학교의 학년들을 목록으로 받는 요청이라 추론 가능.
{"results" : [ {"idx": 1, "name": "1학년"}, {"idx": 2, "name": "2학년"}, {"idx": 3, "name": "3학년"} ]}https://school.com/grade/2 이렇게 idx, 고유번호가 붙는다면, idx가 2인 학년의 정보가 올거고,
https://school.com/grade/2/students 의 students가 붙으면 2반 학생들의 정보를 받아올 수 있음.
{"results" : [ {"idx": 1, "name": "홍길동", "gender": "male"}, {"idx": 2, "name": "성춘향", "gender": "female"}, {"idx": 3, "name": "전우치", "gender": "male"}, {"idx": 4, "name": "나기백", "gender": "male"}, ... ]}또, https://school.com/grade/2/students/15 라는 idx를 붙이면 그 학생들 중 15의 idx를 가진 학생의 정보가 오겠지?
혹은 https://school.com/grade/2/students?gender=male 와 같이 조건을 붙여서 남학생들의 정보만 받아올 수도 있어~
한 페이지당 10명의 데이터를 받아오는 거라면 이런식으로도 표현이 가능하겠네?
https://school.com/grade/2/students?page=2&count=10
{"results" : [ {"idx": 11, "name": "신짱구", "gender": "male"}, {"idx": 12, "name": "김지우", "gender": "female"}, {"idx": 13, "name": "김화석", "gender": "male"}, {"idx": 14, "name": "박수쳐", "gender": "male"}, ... ]}이렇게 RESTful API는 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것을 목적으로.
만약, 성능이 중요한 상황이라면 굳이 RESTful 한 API를 구현할 필요는 없음!!!
🗒 MEMO
💡 안되면 될 때 까지!회고🤔
어제 처음 스프링 공부를 시작했는데 전 날 잠을 못자서 그런지
집중도 안되고 이해도 전~~혀 안됐다.
그래서 오늘 다시 마음 잡고 어제 강의까지 돌려보며 복습했다.
흐름을 아는게 중요하다고 했는데 나느 그 흐름을 너무 몰라서 개념을 이해하려고
알 때 까지 찾아보고 정리했다.
역시 정리다.
정리가 답이었다.
정리를 하니까 머릿속이 정리가 됐다.
정리를 잘 하자.
