최소한 나는 너무나 당황스러웠던 전문용어의 연속이다.
REST, REST API , RESTful , RESTful API

틀린그림 찾기 수준의 단어배열인데, 몰랐던 용어들과 완벽하지는 못하더라도 공부겸 나름 깔끔하게 포스팅 해보았다.

REST

REST는 Representational State Transfer라는 용어의 약자로서 2000년도에 로이 필딩 (Roy Fielding)의 박사학위 논문에서 최초로 소개되었다. 로이 필딩은 HTTP의 주요 저자 중 한 사람으로 그 당시 웹(HTTP) 설계의 우수성에 비해 제대로 사용되어지지 못하는 모습에 안타까워하며 웹의 장점을 최대한 활용할 수 있는 아키텍처로써 REST를 발표했다.

처음 REST는 인터넷 같은 복잡한 네트워크에서 통신을 관리하기 위한 지침으로 만들어졌다. REST기반 아키텍처를 사용하면 대규모의 고성능 통신을 안정적으로 지원할 수 있다. 또한 쉽게 구현하고 수정할 수 있다.

필자가 이해한 방식

미세먼지를 관측해서 결과를 실시간으로 출력해주는 웹 페이지를 만들고 싶을 때, 개발자가 할 수 있는 일은 페이지를 만드는 것 밖에 없다. 직접 관측하는 기기가 없기 때문이다.
그래서 개발자들은 오픈 API를 사용하는데 API는 관측 데이터들을 저장해서 요청하면 그 데이터들로 클라이언트에게 응답한다.

이 API를 만들 때 너무 중구난방으로 만들면 유저들의 혼란이 가중되기 때문에, REST라는 하나의 일종의 규약을 채택하였다.
이것이 RESTful API, REST API인 것이다.

REST의 구성

---

Uniform (유니폼 인터페이스)

Uniform Interface는 URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일을 말한다.

Stateless (무상태성)

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

Cacheable (캐시 가능)

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

Self-descriptiveness (자체 표현 구조)

REST API 메시지만 보고도 이를 쉽게 이해 할 수 있는 자체 표현 구조로 되어 있다.

Client - Server 구조

REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어들게 된다.

계층형 구조

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

REST의 장/단점

---

장점

• HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구출할 필요가 없다.
• HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
• Hypermedia API의 기본을 충실히 지키면서 범용성을 보장한다.
• REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.
  여러가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다.
• 서버와 클라이언트의 역할을 명확하게 분리한다.

단점

• 표준이 존재하지 않는다.
• 사용할 수 있는 메소드가 4가지 밖에 없다. (CRUD)
• HTTP Method 형태가 제한적이다.
• 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 값이 왠지 더 어렵게 느껴진다.
• 구형 브라우저가 아직 제대로 지원해주지 못하는 부분이 존재한다. (PUT, DELETE를 사용하지 못하는 점)

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

REST API란

---

API(Application Programming Interface)란

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

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

두 개의 컴퓨터가 인터넷을 통해 정보를 안전하게 교환하기 위해 사용하는 인터페이스
최근 OpenAPI(누구나 사용할 수 있도록 공개된 API: 구글 맵, 공공 데이터 등), 마이크로 서비스(하나의 큰 애플리케이션을 여러 개의 작은 애플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍처) 등을 제공하는 업체 대부분은 REST API를 제공한다.

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

RESTful이란

---

• RESTful은 일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어이다.
• ‘REST API’를 제공하는 웹 서비스를 ‘RESTful’하다고 할 수 있다.
• RESTful은 REST를 REST답게 쓰기 위한 방법으로, 누군가가 공식적으로 발표한 것이 아니다.
• 사실상 REST API와 RESTful API는 같은 용어라고 생각하면 된다.

RESTful의 목적

---

• 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것
• RESTful한 API를 구현하는 근본적인 목적이 성능 향상에 있는 것이 아니라 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이 주 동기이니, 성능이 중요한 상황에서는 굳이 RESTful한 API를 구현할 필요는 없다.
• RESTful 하지 못한 경우
  Ex1) CRUD 기능을 모두 POST로만 처리하는 API
  Ex2) route에 resource, id 외의 정보가 들어가는 경우(/students/updateName)

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

REST API 설계 기본 규칙

---

참고 리소스 원형

• 도큐먼트 : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념
• 컬렉션 : 서버에서 관리하는 디렉터리라는 리소스
• 스토어 : 클라이언트에서 관리하는 리소스 저장소

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

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

자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현한다.

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

REST API 설계 규칙

---

슬래시 구분자(/ )는 계층 관계를 나타내는데 사용한다.

• Ex) http://restapi.example.com/houses/apartments

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

• URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 한다.
• REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않는다.
  Ex) http://restapi.example.com/houses/apartments/ (X)

하이픈(- )은 URI 가독성을 높이는데 사용

• 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.

밑줄(_ )은 URI에 사용하지 않는다.

• 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않는다.

URI 경로에는 소문자가 적합하다.

• URI 경로에 대문자 사용은 피하도록 한다.
• RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문

파일확장자는 URI에 포함하지 않는다.

• REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.
• Accept header를 사용한다.
  Ex) http://restapi.example.com/members/soccer/345/photo.jpg (X)
  Ex) GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg (O)

리소스 간에는 연관 관계가 있는 경우

• /리소스명/리소스 ID/관계가 있는 다른 리소스명
  Ex) GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)
  https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html

---

편하게 API를 가져다 쓰면서 개꿀~ 하던 나였는데, 누군가가 RESTful하게 설계한 API를 나는 대가없이 잘 쓰고 있었다는 사실이 조금은 부끄러워지는 포스팅이었다.

누군가의 노고덕분에 나는 개발할때의 짐을 하나 덜 수 있게되었다. 또, 내가 누군가에게 API를 배포하기 위해서는 짐이 되지 않기 위해 RESTful API를 반드시 지키며 API를 만드리라고 다짐하게 되었다.