[스터디] REST API

lyshine·2023년 3월 13일

스터디

목록 보기

1/7

먼저 REST에 대해 알아보도록 하자.

REST(Representational State Transfer)
기본 개념 : 자원(resource)을 이름(자원의 표현(representation))으로 구분하여 해당 자원의 상태(정보)를 주고 받는 모든 것을 의미한다.
즉, 자원의 표현(자원이름)에 의한 상태 전달이다.
기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일이다.
네트워크 상에서 클라이언트와 서버 사이 통신 방식 중 하나이다.
HTTP는 " POST, GET, PUT, DELETE "와 같은 메소드를 제공한다.
웹에 존재하는 모든 자원(이미지,동영상,DB 등)에 URI를 부여하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미한다.

** CRUD Operation
Create : 생성(POST)
Read : 조회(GET)
Update : 수정(PUT)
Delete : 삭제(DELETE)
HEAD: header 정보 조회(HEAD)

자원, 행위, 표현으로 구성되어 있다.

자원(Resource) : URI
- 모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
- 자원을 구별하는 ID는 ‘/groups/:group_id’와 같은 HTTP URI 다.
- Client는 URI를 이용해서 자원을 지정하고, 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다.
행위(Verb)
- HTTP Method(POST, GET, PUT, DELETE)
표현(Representation)
- JSON, XML 등을 통해 데이터 주고 받기
- Client가 자원의 상태(정보)에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation)을 보낸다.

✅ Client는 URI를 통해 자원을 지정하고 HTTP METHOD를 통해 서버에 요청하고 서버는 이에 적절한 응답을 하여 자원에 CRUD를 적용한다.

프론트엔드와 백엔드가 구분되고, OPEN API를 제공하고자 함과 멀티 플랫폼에 대한 지원을 위해 서비스 자원에 대한 아키텍처를 세우고 이용하는 방법을 모색한 결과, REST에 관심을 가지게 되었다.

REST API : REST기반으로 서비스 API를 구현한 것

API(Application Programming Interface)란?
데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간 상호작용을 촉진하며, 서로 정보를 교환가능 하도록 하는 것
REST기반으로 시스템을 분산해 확장성, 재사용성이 높아진다. => 유지보수와 운용이 편리해진다.

슬러시 구분자(/)는 계층관계를 나타내는 데 사용한다.
URI 마지막 문자로 슬래시(/)를 포함하지 않는다.
하이픈(-)은 URI 가독성을 높이는 데 사용한다. 가급적 하이픈의 사용도 최소화하며, 정확한 의미나 표현을 위해 단어의 결합이 불가피한 경우에 사용한다.
밑줄(_)은 URI에 사용하지 않는다.
URI는 정보의 자원을 표현해야 한다. 동사보다는 명사를 사용한다.
대문자보다는 소문자가 적합하다.
파일 확장자(ex: .json, .xml, .jpg)는 URI에 포함시키지 않는다.
http://restapi.example.com/members/345/photo.jpg (X)
GET / members/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg (O)
행위는 포함하지 않는다.
행위는 URL대신 HTTP Method를 사용하여 전달한다.(GET, POST, PUT, DELETE 등)
POST http://restapi.example.com/users/1/delete-post/1 (x)
DELETE http://restapi.example.com/users/1/posts/1 (o)
가급적 전달하고자하는 자원의 명사를 사용하되, 컨트롤 자원을 의미하는 경우 예외적으로 동사를 허용한다.
http://restapi.example.com/posts/duplicating(x)
http://restapi.example.com/posts/duplicate (o)
경로 부분 중 변하는 부분은 유일한 값으로 대체한다.