REST API

👉REST란 

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

즉, 자원의 표현에 의한 상태 전달이다. 자원의 표현은 그 자원을 표현하기 위한 이름을 의미하고 상태 전달은 데이터가 요청되는 시점에서 자원의 상태를 전달하는것이다.일반적으로 JSON 이나 XML을 통해 데이터를 주고 받는 것이 있다.

WWW(World Wide Web)과 같은 분상 하이퍼미디어 시스템을 위한 소프트웨어 개발 아키택쳐의 한 형식이다.REST는 기본적으로 웹의 기존의 기술과 HTTP프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키택쳐이다.

REST의 자세한 개념은  HTTP URI를 통해 자원을 명시하고,HTTP Method(POST,GET,PUT,DELETE)를 통해 해당 자원에 대한 CRUD 작업을 적용 하는것이다.

REST는 자원 기반의 구조 설계의 중심에  자원(Resourse)가 있고 HTTP Method를 통해 자원을 처리하도록 설계된 아키텍쳐이다.

 

👉REST가 필요한 이유

• 애플리케이션의 분리 및 통합 
• 다양한 클라이언트 등장
• 서버프로그램은 다양한 브라우저와 안드로이드 ,아이폰 등 모바일 디바이스에서도 통신이 가능해야한다.

👉REST의 장단점

• 장점
  • REST API를 사용하기위해 별도로 인프라를 구축할 필요가 없다.
  • HTTP 표준 프로토콜에 따르는 모든 플랫폼이 사용가능하다.
  • 하이퍼미디어API 의 기본을 충실히 지키면서 범용성을 보장한다.
  • 서버와 클라이언트 역할 분리가 확실하다.
  • HTTP 프로토콜의 표준을 최대한 활용하여 추가적인 장점을 함께 가져갈 수 있게 해준다.
• 단점 
  • 명확한 표준이 존재하지 않는다.
  • HTTP Method형태가 제한적이다.
  • 구형 브라우저는 아직 제대로 지원해주지 못해 PUT,DELETE를  사용하지 못한다.

👉REST의 구성요소 

• 자원(Resourse)
  • 모든 자원에는 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
  • 자원을 구별하는 고유한 ID는 HTTP URI이다.
  • 클라이언트는 URI를 이용해서 자원을 선택하고 해당 자원의 상태에 대한 조작을 Server에 요청한다.
• 행위(Verb)
  • HTTP 프로토콜은 GET, POST, PUT, DELETE 와 같은 메서드를 제공한다.
• 표현(Representations)
  • 클라이언트가 자원의 상태에 대한 조작을 요청하면 Server는 이에 적정한 응답을 보낸다.
  • REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타내어 질 수 있다.
  • JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.
    
    

👉REST 특징 

• Server-Client
  • 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 된다.
    • Server : API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다.
    • Client : 사용자 인증이나 context등을 직접 관리하고 책임진다.
  • 서로 간의 의존성이 줄어든다.
• Stateless(무상태)
  • HTTP 프로토콜은 Stateless Protocol이므로 REST 또한 무상태성을 갖는다.
  • 클라이언트의 context를 서버에 저장하지 않는다.(세션과 쿠키와 같은 context정보를 신경쓰지 않아도 되므로 구현이 단순해진다.)
  • 서버는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다.
    • API서버는 Client의 요청만을 처리한다.
    • 이전 요청이 다음요청에 영향을 주어서는 안된다.(DB를 수정하여 DB에 의해 바뀌는 것은 상관없음)
    • 서버의 처리 방식에 일관성을 부여하고 부담이 줄어들어 서비스의 자유도가 높아진다.
• Cacheable
  • HTTP프로토콜을 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용가능하다.(대표적으로 캐싱기능 사용가능)
  • 대량의 요청을 효율적으로 처리하기 위해 캐시가 요구된다.
  • 캐시 사용을 통해 응답시간이 빨리지고 REST 서버 트랜잭션이 발생하지 않기 때문에 전체 응답시간이나 성능, 서버의 자원 이용률을 향상 시킬수 있다.
• Layered System
  • 클라이언트는 REST API 서버만 호출한다.
  • REST 서버는 다중 계층으로 구성 가능하다.(로드밸런싱,공유캐시 등을 통해 확장성과 보안성을 향상시킬 수 있다.)
  • 네트워크 기반의 중간 매체를 사용할 수 있다.(EX: proxy,Gateway)
• Code-on-Demand
  • 서버로 부터 스크립트를 받아서 Client에서 실행한다.
• Uniform Interface
  • URI로 지정한 Resourse에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.
  • HTTP 표준을 따르는 모든 플랫폼에서 사용가능하다.

 

👉REST API란 

API(Application programming Interface)

• 데이터와 기능을 모아서 컴퓨터 프로그램간에 상호작용을 촉진하며, 서로 정보를 교환가능 하도록 하는것

REST API

 

• REST API는 REST기반으로 API를 구현한 것이다.
• REST 기반으로 시스템을 분상해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할수있다.
• REST는 HTTP 기반으로 구현하므로,HTTP를 지원하는 프로그램언어로  클라이언트 ,서버를 구현할 수 있다.

👉REST API  설계  규칙

URI는 정보의 자원을 표현해야 한다.

• 리소스는 동사보다 명사,대문자보다는 소문자를 사용한다.
• 리소스는 도큐먼트 이름으로는 단수 명사를 사용해야 한다.
• 리소스의 컬렉션 이름으로는 복수 명사를 사용해야 한다.
• 리소스의 스토어 이름으로는 복수 명사를 사용해야 한다.
  • EX) GET /Member/1 -> GET /members/1

리소스에 대한 행위는 HTTP Method(GET, PUT ,POST DELETE)로 표현한다.

• URI에 HTTP Method가 들어가면 안된다.
  • EX)GET /store/delete/1  -> DELETE /stores/1
• URI에 행위에 대한 동사 표현이 들어가면 안된다.
  • EX)GET /store/show/1  -> GET /stores/1
  • EX)GET /store/insert/12  -> POST /store/1
• 경로 부분 중 변하는 부분은 유일한 값으로 대체한다.
  • id = 1 인 상품 삭제하는 route : DELETE/product/1

👉설계 규칙

• 슬래시(/)는 계층 관계를 나타내는데 사용한다.
  • EX)http://localhost.com/product/1
• URI 마지막 문자로 슬래시(/)를 포함하지 않는다.
  • URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 한다.
  • URI 경로 마지막에는 슬래시(/)를 사용하지 않는다.
  • EX)http://localhost.com/product/1/  (X)
• 하이픈( - )은 가독성을 높이는데 활용한다.
  • 긴 URI경로를 사용하게되면 하이픈을 사용해 가독성을 높인다.
• 밑줄(_)은 URI에 사용하지 않는다.
  • 문자에 가려질수 있으므로 밑줄은 사용하지 않는다.
• URI경로에는 소문자가 적합하다.
  • RFC 3986은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문에 대문자를 사용하지 않는다.
• 파일확장자는 URI에 포함하지 않는다.
  • REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.
    
  • Ex) http://localhost.com/product/1/photo.jpg (X)
    Ex) GET /product/1/photo HTTP/1.1 Host: localhost.com Accept: image/jpg (O)
    
    

 

---

📁REFERENCE

• https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html