좋은 REST API란 ?

작성자
REST API란 REST를 기반으로 만들어진 API를 의미합니다.
REST API를 알기 위해선 REST를 먼저 알아야 합니다.

REST 란 ?

REST : Representational State Transfer 의 약자로 자원을 이름으로 구분하여 해당 자원의 상태를 주고받는 모든 것을 의미.
즉 REST는 HTTP URI 를 통해 자원을 명시하고 HTTP Method를 통해 해당 자원에 대한 CRUD Operation 을 적용하는 것을 의미.
CRUD Operation은 대부분 컴퓨터 소픝트웨어가 가지는 기본적인 데이터 처리 기능인 Create, Read, Update, Delete를 묶어서 사용하는 단어이며
REST에서 CRUD Operation은 다음 표와 같다.
Create
생성(POST)
Read
조회(GET)
Update
수정(PUT, PATCH)
Delete
삭제(DELETE)

REST 구성 요소

REST는 3가지로 구성되어 있으며
1.
자원(Resource) : HTTP URI (Uniform Resource Identifier)
2.
자원에 대한 행위(Verb) : HTTP Method → POST, GET, PUT, PATCH, DELETE
3.
자원에 대한 행위의 내용 (Representations) : HTTP Message Pay Load

REST의 특징

1.
Server - Client 구조
2.
무상태 (Stateless)
3.
캐시 처리 가능(Cacheable)
4.
계층화 (Layered System)
5.
인터페이스 일관성 (Uniform Interface)

REST의 장점

1.
HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구축할 필요가 없음.
2.
HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해줌.
3.
HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능.
4.
Hypermedia API의 기본을 충실히 지키면서 범용성을 보장.
5.
REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있음.
6.
여러 가지 서비스 디자인에서 생길 수 있는 문제를 최소화.
7.
Server와 Client의 역할을 명확하게 분리.

REST의 단점

1.
표준이 자체가 존재하지 않아 정의가 필요
2.
HTTP Method 형태가 제한적
3.
Brower를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 정보의 값을 처리 해야 하므로 전문성이 요구됨. → 쉽게말해어려움
4.
구형 Brower에서 호환이 되지 않아 지원해주지 못하는 동작이 많음.(Explorer)

REST API 란 ?

REST API 란 가장 위에 설명한 것과 같이 REST를 기반으로 만들어진 API를 의미.
But, REST API를 올바르게 설계하기 위해서는 지켜야 하는 몇가지 규칙이 있으며 해당 규칙을 알아보겠음.

REST API 설계 예시

1.
URI 는 소문자로만 구성
2.
URI 에는 행위 포함 x
3.
언더바 대신 하이픈을 사용
4.
슬래시는 계층 관계를 표현
5.
URI의 마지막 문자로 슬래시를 포함 x
6.
파일 확장자는 URI에 포함 x
7.
URI에서 영어는 복수형으로 작성

REST API vs RESTful API

REST와 RESTful의 차이는 REST의 설계 규칙을 잘 지켜서 설계된 API를 RESTful API라고 하며 RESTful하게 만든 API는 요청을 보내는 주소만으로도 어떤 것을 요청하는지 파악할 수 있음.
RESTful API는 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것을 목적으로 함.