TIL ( API, REST API )

💡 API, REST API 제대로 이해하기

 

1. REST API란 ?

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

 

2. REST 특징

- REST의 대표적인 특징으로 유니폼인터페이스, 무상태성, 캐시가능, 자체표현구조 등이 있습니다. 

 

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

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

• 무상태성(Stateless)

 - 작업을 위한 상태정보를 따로 저장하고 관리하지 않습니다. 세션정보나 쿠키정보를 별도로 저장하고 관리하지 않기 때문에 서비스의 자유도가 높아지고 구현이 단순해집니다.

• 캐시가능(Casheable)

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

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

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

 

3. REST의 구성요소

- REST는 자원(Resource)-URL / 행위(Verb)-HTTP Method / 표현(Representations)으로 구성되어 있습니다.

 

4. REST API 설계

- REST API 설계시 가장 중요한 항목은 URL은 정보의 자원을 표현해야하고, 자원에 대한 행위는 HTTP Method (GET, POST, PUT, DELETE)로 표현해야합니다.

• URL은 정보의 자원을 표현해야 한다.

 ex) GET/movies/1

• 자원에 대한 행위는 HTTP Method로 표현해야 한다.

 - GET: 리소스 조회할때 사용 / POST는 리소스를 생성할때 사용 / PUT은 리소스를 수정할때 사용 / DELETE는 리소스 삭제할 때 사용합니다.

 

5. URL 설계시 주의점

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

 ex) http://example.com/movies/comic/1

• 하이픈(-)은 url 가독성을 높이는데 사용합니다.

• 밑줄(_)은 url에 사용하지 않습니다.

• url 경로에는 소문자가 적합합니다.

 

+  HTTP 응답 상태코드 정리

 - 200 : 클라이언트의 요청을 정상적으로 수행

 - 210 : 클라이언트가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성됨

 - 301 : 리소스에 대한 URL이 변경되었을 때 사용

 - 400 : 클라이언트의 요청이 부적절할 경우 사용하는 응답 코드 

 - 401 : 인증되지 않은 상태에서 보호된 리소스를 요청했을 때 사용

 - 404 : 요청한 리소스가 존재하지 않을 때 사용