REST API란?

Junwon SEO·2022년 10월 24일
0

CS 스터디

목록 보기
2/4

1. REST API란?

REST API란 REpresentational State Transfer API의 약자로
글자 그대로 REST를 기반으로 만들어진 API를 의미한다.

쉽게말해 REST API는 REST와 API가 합쳐진 개념이다.
우선 REST란 무엇인가에 대해 알아보기로 하자.

2. REST란 무엇인가

REST(Representational State Transfer)의 약자로 자원을 이름(자원의 표현)으로 구분하여 해당 자원의 상태(정보)를 주고 받는 모든 것을 의미한다.

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

3. REST의 구성

REST API의 구성은 아래와 같다.

  • 자원(RESOURCE) - URI
  • 행위(Verb) - HTTP METHOD
  • 표현(Representations)

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

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

5. REST API 디자인 가이드

REST API 설계 시 가장 중요한 항목은 아래의 2가지로 요약할 수 있다.

첫 번째, URI는 정보의 자원을 표현해야 한다.
두 번째, 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현한다.

6. REST API 중심 규칙

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

GET /user/read/1 (X)
GET /user/1      (O)

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

GET /user/insert/1 (X)
POST /user/1     (O)

7. URI 설계 시 주의사항

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

http://test.com/gdsc/server
http://test.com/animals/mammals/whales

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

http://test.com/gdsc/server/  (X)
http://test.com/gdsc/server   (O)

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

http://test.com/gdscserverteam
http://test.com/gdsc-server-team

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

http://test.com/gdsc_server_team (X)
http://test.com/gdsc-server-team (O)

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

http://test.com/GdscServerTeam   (X)
http://test.com/gdsc-server-team  (O)

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

http://test.com/gdsc/solution.jpeg (X)

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

/리소스명/리소스ID/관계가 있는 다른 리소스명
GET /user/:userId/post

8. RESTful이란?

REST 원리를 따르는 시스템은 RESTful이란 용어로 지칭된다.

RESTful은 일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어이다. ‘REST API’를 제공하는 웹 서비스를 ‘RESTful’하다고 할 수 있다. RESTful은 REST를 REST답게 쓰기 위한 방법의 일환이다.

RESTful의 목적

  • 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것
  • RESTful한 API를 구현하는 근본적인 목적은 성능 향상에 있는 것이 아니다.
  • 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이 주 목적.
  • 성능이 중요한 상황에서는 굳이 RESTful한 API를 구현할 필요는 없다.

RESTful 하지 못한 경우

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

0개의 댓글