[Network] REST API

 

REST(Representational State Transfer)

REST이란 자원을 이름으로 구분하여 해당 자원의 상태(정보)를 주고받는 모든 것을 의미한다. 즉, 자원의 표현(representational)에 의한 상태 전달(State Transfer)을 말한다.

 

이때 자원이란 해당 소프트웨어가 관리하는 모든 것을 말하며 자원의 표현은 그 자원을 표현하기 위한 이름을 뜻한다. 예로 DB의 학생 정보가 자원일 때, 'students'를 자원의 표현으로 정하는 예가 있다. 

 

상태(정보) 전달이란 데이터가 요청되어지는 시점에 자원의 상태(정보)를 전달하는 것을 말하며 JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다. 

 

기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍쳐 스타일이며 네트워크 상에서 Client 와 Server 사이의 통신 방식 중 하나이다.

 

REST 의 개념을 말하자면 HTTP URI 를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT DELETE) 를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미한다. 즉 REST는 자원 기반의 구조(ROA, Resource Oriented Architecture) 설계의 중심에 Resource가 있고 HTTP Method를 통해 Resource를 처리하도록 설계된 아키텍쳐를 의미한다. 웹 사이트의 이미지, 텍스트, DB 내용 등의 모든 자원에 고유한 ID인 HTTP URI를 부여한다.

 

• CRUD Operation
  • CREATE (POST) : 생성
  • READ (GET) : 조회
  • UPDATE (PUT) : 수정
  • DELETE : 삭제
  • HEAD : header 정보 조회

 

장단점

• 장점
  • HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구축할 필요가 없다.
  • HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해준다.
  • HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
  • REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.
  • 서버와 클라이언트 역할을 명확하게 분리한다.
• 단점
  • 표준이 존재하지 않는다.
  • 사용할 수 있는 메소드가 4가지(HTTP Method) 만 있다. 
  • 구형 브라우저에서 아직 제대로 지원해주지 못하는 부분(PUT, DELETE를 사용하지 못한다.)이 존재한다.

 

---

REST API

여기서 API란 데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간 상호작용을 촉진하며, 서로 정보를 교환가능 하도록 하는 것을 말한다. 

 

REST API란 REST 기반으로 서비스 API를 구현한 것이며 OpenAPI(누구나 사용할 수 있는 공개된 API) 는 대부분 REST API를 제공한다.

 

설계 기본 규칙

• URI는 자원의 정보를 표시해야 한다.
  • resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다
  • resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다
  • resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다
  • resource의 스토어 이름으로는 복수 명사를 사용해야 한다 
  • GET /Member/1 -> GET /members/1

 

• 자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE) 로 표현한다.
  • URI에 HTTML Method가 들어가면 안된다
  • GET /members/delete/1 -> DELETE /members/1
  • URI에 행위에 대한 동사 표현이 들어가면 안된다(CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.)
  • GET /members/show/1 -> GET /members/1 GET /members/insert/2 -> POST /members/2
  • 경로 부분 중 변하는 부분은 유일한 값으로 대체한다(즉 :id는 하나의 특정 resource를 나타내는 고유값이다)
    • Ex) student를 생성하는 route: POST/students
    • Ex) id=12인 student를 삭제하는 route: DELETE/students/12

 

REST API 설계 규칙

1. 슬래시 구분자(/)는 계층 관계를 나타내는데 사용한다. 
2. http://restapi.example.com/houses/apartments
3. URI 마지막 문자로 슬래시를 포함하지 않는다
   • URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르며 URI도 달라져야 한다. 
   • http://restapi.example.com/houses/apartments/ (x)
4. 하이픈(-) 은 URI 가독성을 높이는데 사용
   • 불가피하게 긴 URI 경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.
5. 밑줄(_)은 사용하지 않는다.
   • 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용 x
6. URI 경로에는 소문자가 적합
   • URI 경로에 대문자 사용은 피하도록 한다
   • RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문
7. 파일 확장자는 URI에 포함하지 않는다.

 

설계 예시

 

---

RESTful

RESTful은 일반적으로 REST라는 아키텍쳐를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어이다. REST API를 제공하는 웹 서비스를 RESTful하다고 할 수 있다. RESTful은 REST를 REST 답게 쓰기 위한 방법으로, 누군가가 공식적으로 발표한 것이 아니다. 즉, REST 원리를 잘 따르는 시스템은 RESTful 용어로 지칭된다.

 

목적

• 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것이 목적이다.

 

RESTful하지 못한 경우

• CRUD 기능을 모두 POST 로만 처리하는 API
• route에 resource, id 외의 정보가 들어가는 경우

 

 

---

참고

https://velog.io/@seokkitdo/Network-REST%EB%9E%80-REST-API%EB%9E%80-RESTful%EC%9D%B4%EB%9E%80