REST API 이해하기

1. REST  API란?

1) REST(Representational State Transfer)

웹에 존재하는 모든 자원(이미지, 동영상, DB)에 고유한 URL을 부여하여 활용하는 것을 의미합니다.

 

2) API(Application Programming Interface)

다른 소프트웨어 시스템과 통신하기 위해 따라야 하는 규칙입니다.

 

3) REST API

REST의 특징을 기반으로 서비스 API를 구현한 것을 말합니다. 참고로 RESTful API는 REST의 설계 규칙을 잘 지켜서 설계된 API입니다.

 

 

2. REST  구성요소

1) 자원(Resource), URL

모든 자원은 고유한 ID를 가지며 ID는 서버에 존재하고 클라이언트는 각 자원의 상태를 조작하기 위해 요청을 보냅니다. 

 

2) 행위(Verb), Method

클라이언트는 URL을 이용해 자원을 지정하고 자원을 조작하기 위해 Method를 사용합니다.

 

3) 표현(Representation)

클라이언트가 서버로 요청을 보냈을 때 응답 자원의 상태를 Representation이라고 합니다.

 

 

3. REST  API가 필요한 이유

REST API의 목적은 이해하기 쉽고 사용하기 쉬운 API를 제작하는데에 있습니다.

 

1) GET /deleteUserInfo/id?=3 

2) DELETE /users/3 

 

두 요청은 모두 특정 user의 정보를 삭제하는 API입니다. 하지만 1번 API는 RESTful 하지 못합니다. REST API의 목적은 이해하기 쉬운 API 제작이 목적이기 때문입니다. 참고로 REST API를 사용한다고 해서 성능이 향상되는 건 아닙니다.

 

 

4. REST  API  디자인 가이드

1) URI는 명사를 사용합니다. (예: /getUsers, /createNewUser)

 

2) 슬래시(/)로 계층 관계를 표현합니다. (예: /main/comment)

 

3) URI 마지막 문자로 슬래시(/)를 포함하지 않습니다.

 

4) 밑줄( _ )을 사용하지 말고 하이픈( - )을 사용합니다.

 

5) URI는 소문자로만 구성합니다.

 

6) HTTP 응답 상태 코드를 사용합니다. (예: 200번대 : 성공, 400번대 : 클라이언트 실패, 500번대 : 서버 실패)

 

7) 파일 확장자는 URI에 포함하지 않습니다. (예: https://test.co.kr/test/img.jpg)

 

 

 

출처

REST API란, HTTP Method

REST란? REST API / RESTful API차이점