REST API 정의 및 특징

1. REST API란?

  API는 애플리케이션이나 디바이스가 서로 간에 연결하여 통신할 수 있는 방법을 정의하는 규칙 세트이다. 여기서 REST API는 Representational State Transfer Application Programming Interface의 약자로, 자원을 이름으로 구분하여 해당 자원의 상태를 주고 받는 통신 규칙이라 할 수 있으며 RESTful API라고도 한다.

  REST API는 HTTP URI(Uniform Resource Identifier)를 통해 자원을 명시하고, HTTP Method(POST, GET, PUT, PATCH, DELETE 등)를 통해 해당 자원(URI)에 대한 CRUD(CREATE:생성, READ:읽기, UPDATE:갱신, DELETE:삭제)를 구현하는 것을 의미한다.

 

2. REST의 특징

1) Uniform (유니폼 인터페이스)

  Uniform Interface는 URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일을 말한다. 이를 위한 네 가지 아키택처 제약 조건은 다음과 같다.

• 클라이언트가 특정 자원을 식별할 수 있는 고유한 식별자를 통해 서버에 요청을 보내야 한다.
• 클라이언트가 리소스를 수정하거나 삭제하는 데 필요한 정보를 리소스 표현에서 얻을 수 있어야 한다.
• 클라이언트에 반환되는 메시지 속에 클라이언트가 정보를 어떻게 처리해야 할지에 대한 정보가 충분히 포함되어야 한다.
• 클라이언트가 리소스에 액세스한 후 하이퍼링크를 통해 수행 가능한 기타 모든 작업을 찾을 수 있어야 한다.

 

2) Stateless (무상태성)

  REST는 무상태성 성격을 갖는다. 다시 말해 작업을 위한 상태정보를 따로 저장하고 관리하지 않는다. 세션 정보나 쿠키정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 된다. 때문에 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해진다.

 

3) Cacheable (캐시 처리 가능)

  REST의 가장 큰 특징 중 하나는 HTTP라는 기존 웹표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용이 가능하다. 따라서 HTTP가 가진 캐싱 기능을 적용할 수 있고, HTTP 프로토콜 표준에서 사용하는 Last-Modified태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.

 

4) Self-descriptiveness (자체 표현 구조)

  REST의 또 다른 큰 특징 중 하나는 REST API 메시지만 보고도 이를 쉽게 이해 할 수 있는 자체 표현 구조로 되어 있다는 것이다.

 

5) Server - Client(서버-클라이언트 구조)

  자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 된다. REST 서버는 API를 제공하고 비지니스 로직 처리 및 저장을 책임진다. 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보) 등을 직접 관리하는 구조이다. 각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어들게 된다.

 

6) Layered System (계층형 구조)

  REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게 한다.

 

3. REST API 설계 기본 규칙

1) URI는 정보의 자원을 표현해야 한다.

(1) 리소스는 동사보다는 명사를, 대문자보다는 소문자를 사용한다.

(2) 리소스의 도큐먼트(객체 인스턴스나 데이터베이스 레코드와 유사한 개념) 이름으로는 단수 명사를 사용해야 한다.

(3) 리소스의 컬렉션(서버에서 관리하는 디렉터리라는 리소스) 이름으로는 복수 명사를 사용해야 한다.

(4) 리소스의 스토어(클라이언트에서 관리하는 리소스 저장소) 이름으로는 복수 명사를 사용해야 한다.

• EX ) GET /Member/1 -> GET /members/1

 

2) 자원에 대한 행위는 HTTP Method로 표현한다.

(1) URI에 HTTP Method가 들어가면 안 된다.

• EX) GET members/delete/1 -> DELTE /members/1

 

(2) URI에 행위에 대한 동사 표현이 들어가면 안 된다.

• EX) GET /members/show/1 -> GET /members/1
• EX) GET /members/insert/1 -> POST /members/1

 

(3) 경로 부분 중 변하는 부분은 유일한 값으로 대체한다.

• EX) Student를 생성하는 Router : POST /students
• EX) ID=12인 Student를 삭제하는 Router : DELETE /students/12

 

3) 슬래시 구분자(/)는 계층 관계를 나타내는데 사용한다. 단 마지막 문자로 슬래시(/)를 사용하지 않는다.

• EX) http://restapi.ex.com/houses/apartments

 

4) 하이픈(-)은 URI 가독성을 높이는 데 사용하고 밑줄(_)은 사용하지 않는다.

 

5) URI 경로에는 대문자 사용을 피하고 소문자를 사용한다.

 

6) URI에 파일 확장자를 사용하지 않는다.

 

- 참고자료

https://www.ibm.com/kr-ko/topics/rest-apis

https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html

https://aws.amazon.com/ko/what-is/restful-api/

https://meetup.nhncloud.com/posts/92