Study/Computer Science

[CS] REST API

taecongs 2023. 10. 24. 10:44

알고있으면 좋은 Computer Science Tip✨

REST API란 무엇인가?

  • REST API는 REST를 기반으로 만들어진 API를 의미한다.

 

(1) REST란?

  • 자원을 이름으로 구분하여 해당 자원의 상태(정보)를 주고받는 모든 것을 의미한다.
    1. 자원의 표현
      • 자원 : 해당 소프트웨어가 관리하는 모든 것이다.
      • 자원의 표현 : 그 자원을 표현하기 위한 이름을 말한다.
    2. 상태(정보) 전달
      • 데이터가 요청되어지는 시점에 자원의 상태(정보)를 전달한다.
      • JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.
  • HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE, PATCH 등)를 통해 해당 자원(URI)에 대한 CRUD Operation을 적용하는 것을 의미한다.

 

(2) REST 구성 요소

  • 자원(Resource) : HTTP URI (모든 자원은 고유한 아이디가 존재하고, 이 자원은 서버에 존재한다.)
  • 행위(Verb) : HTTP Method를 이용해야 한다.
  • 표현(Representations) : 클라이언트가 자원의 상태에 대한 조작을 요청하면 서버는 이에 적절한 응답을 보내준다.

 

(3) REST 특징

  • Server-Client(서버-클라이언트 구조)
  • Stateless(무상태)
  • Cacheable(캐시 처리 가능)
  • Layered System(계층화)
  • Uniform Interface(인터페이스 일관성)

 

(4) REST의 장·단점은?

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

 

REST API 설계 규칙

  • REST API를 올바르게 설계하기 위해서는 지켜야 하는 몇가지 규칙이 존재한다.

 

(1) URI는 동사보다는 명사를, 대문자보다는 소문자를 사용하여야 한다.

[Bad Example]  https://taecongs.tistory.com/Page1/
[Good Example] https://taecongs.tistory.com/page1/

 

(2) 마지막에 슬래시 (/)를 포함하지 않는다.

[Bad Example]  https://taecongs.tistory.com/Page1/
[Good Example] https://taecongs.tistory.com/page1

 

(3) 언더바 대신 하이폰을 사용한다.

[Bad Example]  https://taecongs.tistory.com/Page_1/
[Good Example] https://taecongs.tistory.com/page-1

 

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

[Bad Example]  https://taecongs.tistory.com/lgtwins.png
[Good Example] https://taecongs.tistory.com/lgtwins

 

(5) 행위를 포함하지 않는다.

[Bad Example]  https://taecongs.tistory.com/delete-post/1
[Good Example] https://taecongs.tistory.com/post/1

 

⭐용어 공부⭐

(1) RESTful

  • REST API를 제공하는 웹사이트를 RESTful 하다고 할 수 있고 RESTful API를 통해 이해하기 쉬운 API를 만드는 것이 목적이다.
  • URI 와 HTTP를 기반으로 자원에 접근할 수 있도록 제공하는 애플리케이션 개발 인터페이스이며, URI는 정보의 자원만 표현해야하고 자원의 상태와 행위는 HTTP 메서드에 명시해야한다.