📌REST API, RESTful API 차이점
결론 : RESTful은 REST의 설계 규칙을 잘 지켜서 설계된 API를 RESTful한 API
즉, REST의 원리를 잘 따르는 시스템을 RESTful이란 용어로 지칭한다.
📌REST(REpresentational State Transfer)
-
"REpresentational State Transfer"
-
자원을 이름(자원의 표현)으로 구분해 해당 자원의 상태를 주고 받는 모든 것
- 어떤 자원을
- URI(Resource)로 Method(GET, POST 등의 방식)을 사용하여 요청을 보낸다.
- 왜? CRUD(Create, Read, Update, Delete) 연산을 수행하기 위해!
- 요청을 위한 자원은 특정한 형태(Representation of Resource)로 표현된다.
즉, 자원(resource)의 표현(representation)에 의한 상태 전달을 뜻합니다.
자원
해당 소프트웨어가 관리하는 모든 것 ( 문서, 그림, 데이터, 해당 소프트웨어 자체 등 )
표현
그 자원을 표현하기 위한 이름
DB의 학생 정보가 자원이면, 'students'를 자원의 표현으로 정함
상태 전달
데이터가 요청되는 시점에 자원의 상태를 전달한다.
JSON 혹은 XML을 통해 데이터를 주고 받는 것이 일반적
- 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에,
웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일 - 네트워크 상에서 Client와 Server 사이의 통신 방식 중 하나
📌 URI 와 URL의 차이점?
- URL은 인터넷 상 자원의 위치를 의미
- URI는 인터넷 상의 자원을 식별하기 위한 문자열의 구성으로,
URI는 URL을 포함하게 된다.
✔️ URI가 URL보다 포괄적인 범위라고 할 수 있다.
📌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 API 란?
REST의 특징을 기반으로 서비스 API를 구현한 것
✔️ REST API의 특징
각 요청이 어떤 동작이나 정보를 위한 것인지를 그 요청의 모습 자체로 추론이 가능한 것
✔️ REST API 디자인 가이드
- URI는 정보의 자원을 표현해야 한다.
2.자원에 대한 행위는 HTTP Method(GET, POST, PUT, PATCH, DELETE)로 표현한다. - 행위(Method)는 URI에 포함하지 않는다.
✔️ REST API의 설계 규칙
-
URI는 명사를 사용한다.(리소스명은 동사가 아닌 명사를 사용해야 한다.)
1-1. 아래와 같은 동사를 사용하지 말 것
/getAllUsers
/getUserById
/createNewUser -
슬래시( / )로 계층 관계를 표현한다.
- URI 마지막 문자로 슬래시 ( / )를 포함하지 않는다.
-
밑줄( _ )을 사용하지 않고, 하이픈( - )을 사용한다.
-
URI는 소문자로만 구성한다.
-
HTTP 응답 상태 코드 사용
- 클라이언트는 해당 요청에 대한 실패, 처리완료 또는 잘못된 요청 등에 대한 피드백을 받아야 한다.
- 파일확장자는 URI에 포함하지 않는다.
Ex) https://velog.io/@yellowbutter0327/restapi/220/photo.jpg (X)
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반 학생들의 정보를 받아올 수 있다.
