REST API 공부하기!

이번에 회사에서 새로운 프로젝트인 Open API서버 개발 및 기존에 맡았던 프로젝트 개발을 맡게 되어 한동안 바빴었다.

 

일을 하면서 사용법만 알았지 REST API가 왜 사용하는지 만드는데 어떤 규칙이 있는지 알아보자.

 

 

 

 

1. REST API의 탄생

REST(Representational State Transfer)는 월드 와이드 웹과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 아키텍처의 한 형식이다. 이 용어는 로이 필딩(Roy Fielding)의 2000년 박사학위 논문에서 소개되었다. 필딩은 HTTP의 주요 저자 중 한 사람이다. 이 개념은 네트워킹 문화에 널리 퍼졌다.

엄격한 의미로 REST는 네트워크 아키텍처 원리의 모음이다. 여기서 '네트워크 아키텍처 원리'란 자원을 정의하고 자원에 대한 주소를 지정하는 방법 전반을 일컫는다. 간단한 의미로는, 웹 상의 자료를 HTTP위에서 SOAP이나 쿠키를 통한 세션 트랙킹 같은 별도의 전송 계층 없이 전송하기 위한 아주 간단한 인터페이스를 말한다. 이 두 가지의 의미는 겹치는 부분과 충돌되는 부분이 있다. 필딩의 REST 아키텍처 형식을 따르면 HTTP나 WWW이 아닌 아주 커다란 소프트웨어 시스템을 설계하는 것도 가능하다. 또한, 리모트 프로시저 콜 대신에 간단한 XML과 HTTP 인터페이스를 이용해 설계하는 것도 가능하다.

 

위 글은 위키백과에있는 REST의 뜻이다. 위 글을 한마디로 줄이면 HTTP 통신을 하여 필요한 CRUD 역활을 하는 것이다. 이 때 HTTP 통신을 한 서버가 어떤 언어로 구성되었든지 상관이 없다 .REST는 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일이다.

 

 

2. REST API 구성

자원(RESOURCE) - URI

• 서버는 Unique한 ID를 가지는 Resource를 가지고 있으며, 클라이언트는 이런한 Resource에 요청을 보낸다. 
• Clident는 URI를 이용하여 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다.
• 예제
  • http://restapi.example.com.animals/mammals/whales

행위(Verb) - HTTP METHOD

• 서버에 요청을 보내기 위한 방식으로 GET, POST, PUT, DELETE가 있습니다. CRUD 연상 중에서 처리를 위한 연산에 맞는 Method를 사용하여 서버에 요청을 보내야 한다.

표현(Representations)

• 클라이언트와 서버가 데이터를 주고 받는 형태로 json, xml, text, res 등이 있다.
• Key, Value를 사용하는 JWT(JSON Web Token) 형태를 많이 사용한다.

 

3. REST의 특징

Uniform(유니폼 인터페이스)

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

Statelee(무상태성)

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

Cacheable(캐시 가능)

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

Self-descriptiveness(자체 표현 구조)

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

Client - Server 구조

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

계층형 구조

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

 

4. REST API 디자인 가이드

첫번째, URI는 정보의 자원을 표현해야 한다.

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

---

4-1. REST API 중심 규칙

1) URI는 정보의 자원을 표현해야 한다.(리소스명은 동사보다는 명사를 사용)

GET / members/delete/1

위와 같은 방식은 REST를 제대로 적용하지 않은 URI이다. URI는 자원을 표현하는데 중점을 두어야 한다. delete와 같은 행위에 대한 표현이 들어가서는 안된다.

 

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

위의 잘못된 URL를 HTTP Method를 통해 수정해 보면

DELETE /member/1

으로 수정할수 있다.

회원정보를 가져올 때는 GET, 회원추가시의 행위를 표현하고자 할대는 POST METHOD를 사용하여 표현

 

회원정보를 가져오는 URI

GET /members/show/1   (X)
GET /members/1		(O)

회원을 추가 할 때

GET /members/insert/2  (X)
POST /members/2		   (O)

 

[참고]HTTP METHOD의 알맞은 역활

POST, GET, PUT, DELETE 이 4가지의 Method를 가지고 CRUD를 할 수 있다.

 

METHOD	역활
POST	- POST를 통해 해당 URI를 요청하면 리포스를 생성
GET	- GET를 통해 해당 리소스를 조회 - 리소스를 조회하고 해당 도큐먼트에 대한 자세한 정보를 가져온다.
PUT	PUT를 통해 해당 리소스를 수정한다.
DELETE	DELETE를 통해 리소스를 삭제한다.

다음과 같은 식으로 URI는 지원을 표현하는 데에 집중하고 행위에 대한 정의는 HTTP METHOD를 통해 하는 것이 REST한 API를 설계하는 중심 규칙이다.

---

4-2. URI 설계 시 주의 할 정

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

http://restapi.example.com/houses/apartments
http://restapi.example.com/animals/mammals/whales

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

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

 http://restapi.example.com/houses/apartments/ (X)
 http://restapi.example.com/houses/apartments  (0)

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

URI를 쉽게 읽고 해석하기 위해, 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높일 수 있다.

 

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

글꼴에 따라 다르긴 하지만 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 합니다. 이런 문제를 피하기 위해 밑줄 대신 하이픈(-)을 사용하는 것이 좋다.(가독성)

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

URI 경로에 대문자 사용은 피하도록 해야한다. 대솜누자에 따라 다른 리소스로 인식되기 때문이다. RFC 3986(URI 문법형식)은 URI 스키마와 호스트를 제외하고는 대문자를 구별하도록 구정하기 때문

RFC 3986 is the URI (Unified Resource Identifier) Syntax document

 

6) 파일 확장자는 URI에 포함시키지 않는다.

http://restapi.example.com/members/soccer/345/photo.jpg (X)

REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI안에 포함시키지 않는다. Accept header를 사용 하도록 한다.

GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg

---

4-3. 리소스 간의 관계를 표현하는 방법

REST 리소스 간에는 연관 관계가 있을 수 있고, 이런 경우 다음과 같은 표현방법으로 사용한다.

/리소스명/리소스 ID/관계가 있는 다른 리소스명

ex)GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

---

4-4. 자원을 표현하는 Collection과 Document

Collection과 Documenet에 대해 알면 URI설계가 한층 더 쉬워진다. DOCUMENT는 단순히 문서로 이해해도 되고, 한객체라고 이해해도 된다. 컬렉션은 문서들의 집합, 객체들의 집합이라고 이해하는데 도움을 준다. 컬렉션과 도큐먼트는 모두 리소스라고 표현할 수 있으며, URI에 표현이 된다.

http:// restapi.example.com/sports/soccer

위 URI를 보게되면 sports라는 컬렉션과 soccer라는 도큐먼트로 표현되고 있다고 생각하면 된다.

http:// restapi.example.com/sports/soccer/players/13

sports, player 컬렉션과 soccer, 13(13번 선수)를 의미하는 도큐먼트로 URI가 이루어지게 된다. 여기서 중요한 점은 컬렉션은 복수로 사용되고 있다. 좀더 직관적인 REST API를 위해서는 컬렉션과 도큐먼트를 사용할 때 단수 복수도 지켜준다면 좀더 이해하기 쉬운 URI를 설계할 수 있다.

 

 

5. HTTP 응답 상태 코드

잘 설계된 API는 URI만 잘 설계된 것이 아닌 그 리소스에 대한 응답을 잘 내어주는 것까지 포함되어야 한다. 정확안 응답의 상태코드만으로 많은 정보를 전달할 수가 있기 때문에 응답의 상태코드 값을 명확히 돌려주는 것은 생각보다 중요한 일이다. 

 

상태코드
200	- 클라이언트의 요청을 정산적으로 수행함
201	- 클라이언트가 어떠한 리소스 생성을 요청 - 해당 리소스가 성공적으로 생성됨(POST를 통한 리소스 생성 작업시)

상태코드
400	- 클라이언트의 요청이 부적절 할 경우에 사용하는 응답코드
401	- 클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때 사용하는 응답코드 - 로그인하지 않은 유저가 로그인 해씅ㄹ대, 요청가능한 리소스를 요청했을 때
403	- 유저 인증상태와 관계 없이 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때 사용하는 응답 코드 - 403 자체가 리소스가 존재하기 때문에 403보다는 400이나 404를 사용할 것을 권고
405	- 클라이언트가 요청한 리소스에서는 사용 불가능한 Method를 이용했을 경우 사용하는 응답 코드

상태코드
301	- 클라이언트가 요청한 리소스에 대한 URI가 변경 되었을 때 사용하는 응답 코드 - 응답 시 Location header에 변경된 URI를 적어 줘야 한다.
500	서버에 문제가 있을 경우 사용하는 응답 코드

 

 

글을 작성할 때 아래의 참고문헌을 그대로 갖다 쓴게 많다.. 글을 보고 이해하면서 부족함 부분이 많다는 것을 느끼고 내일도 공부해야겠다는 생각이 든다..

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

참고 

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

https://velog.io/@ejchaid/RESTful-API-%EA%B7%B8%EA%B2%8C-%EB%AD%90%EC%95%BC

https://mangkyu.tistory.com/46

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