REST API

sangbin2·2022년 6월 9일
0

1. REST란 ?

Representational State Transfer의 약자로,
네트워크 상에서 Client와 Server 사이의 통신 방식 중 하나이다.
자원(resource)표현(representation)에 의한 상태 전달을 의미한다.

  • 자원 : 해당 소프트웨어가 관리하는 모든 것 ( 문서, 그림, 데이터, 해당 소프트웨어 자체 등 )
  • 표현 : 그 자원을 표현하기 위한 이름 (DB의 학생 정보가 자원이면, 'students'를 표현으로 정의 )
  • 상태 전달 : 데이터가 요청되는 시점에 자원의 상태를 전달 ( JSON, XML )

1-1. REST의 구성 요소

자원(Resource) - URI

  • 모든 자원에는 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
  • 자원을 구별하는 ID는 '/students/:student_id'와 같은 URI이다.
  • Client는 URI를 이용해 자원을 지정하고, 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다.

행위(Verb) - Method ( CRUD )

  • HTTP 프로토콜의 Method를 사용한다.
  • HTTP 프로토콜은 GET, POST, PUT, PATCH, DELETE의 Method를 제공한다.
    • GET : 정보 요청, URI가 가진 정보를 검색하기 위해 서버에 요청한다.(READ)
    • POST : 정보 입력, 클라이언트에서 서버로 전달하려는 정보를 보낸다. (CREATE)
    • PUT : 정보 업데이트, 정보 전체를 교체할 때 사용한다. (UPDATE)
    • PATCH : 정보 업데이트, 정보 일부를 수정할 때 사용한다. (UPDATE)
    • DELETE : 정보 삭제 (DELETE)

표현(Representation of Resource)

  • Client와 Server가 데이터를 주고받는 형태로 JSON, XML, TEXT, RSS 등이 있다.

1-2. REST의 특징

서버 - 클라이언트 구조

  • 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client
  • 역할을 확실히 구분시킴으로써 서로 간의 의존성을 줄인다.

무상태

  • HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 갖는다.

캐시 기능

  • HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다.
    • HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있다.
  • 대량의 요청을 효율적으로 처리할 수 있다.

일관성

  • URI로 지정한 Resource에 대한 요청을 일관성 있게 수행할 수 있다.
  • HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.

자체 표현

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

2. REST API

REST의 특징을 기반으로 API를 구현한 것을 의미한다.

2-1. REST API의 특징

REST API의 가장 큰 특징은 각 요청이 어떤 동작이나 정보를 위한 것인지를 그 요청의 모습 자체로 추론이 가능하는 점이다.

2-2. REST API 설계 규칙

  • URI는 정보의 자원을 표현해야 한다.
    • 동사보다는 명사를 사용한다.
    • 대문자 보다는 소문자를 사용한다.
  • 자원에 대한 행위는 HTTP Method(GET, POST, PUT, PATCH, DELETE)로 표현한다.
    • URI에 HTTP Method가 들어가면 안된다.
    • 행위에 대한 동사 표현이 들어가면 안된다.
  • 슬래시 / 구분자는 계층 관계를 타나내는데 사용한다.
https://www.google.com/search/rest
  • URI 마지막 문자로 슬래시/ 를 포함하지 않는다.
https://www.google.com/search/rest/ -> x
  • 불가피하게 긴 URL경로를 사용하게 된다면 하이픈-을 사용해 가독성을 높여준다.
  • 밑줄_은 URI에 사용하지 않는다.
  • 파일 확장자는 URI에 포함하지 않는다.
profile
Developer

0개의 댓글