Rest API

사이드 프로젝트로 Rest API 설계 규칙을 따라서 URL를 작성할 예정이다. 이에 팀원들과 공유하고자 글을 남긴다.

 

▶️Rest란?

• 자원을 이름으로 구분해 해당 자원의 상태(정보)를 주고 받는 모든 것을 의미한다. 즉, 자원(resource)의 표현(representation)에 의한 상태 전달을 뜻한다.
• 웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일

 

▶️Rest 구성 요소

1. Method
   1. Post, Get, Put, Delete
2. Resource
   1. URI : 모든 자원에는 고유한 ID가 존재하고, 이 자원은 Server에 존재한다. Client는 URI를 이용해 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다.
   2. 모든 것을 명사로 표현하고, 세부 Resource에는 id를 붙임
3. Message
   1. 메세지 포맷이 존재(JSON, XML 등..)

 

▶️Rest 특징

• Server-Client 구조
  • Rest Server는 API를 제공하고 비즈니스 로직 처리 및 저장을 책임지고,
  • Client는 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임집니다.
  • 역할을 확실히 구분시킴으로써 서로 간의 의존성을 줄입니다.
• Stateless
  • HTTP 프로토콜은 Stateless Protocol이므로 Rest 역시 무상태성을 갖는다.
  • Client의 context를 Server에 저장하지 않는다.
    • 즉, 세션과 쿠기와 같은 Context 정보를 신경쓰지 않아도 되므로 구현이 단순해진다.
  • Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다.
• Cacheable
  • 웹 표준 http 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다.
    • 즉, http가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있다.
    • http 프로토콜 표준에서 사용하는 last-modified tag 또는 E-Tag를 이용해 캐싱을 구현
• Layered System
  • Client는 Rest api server만 호출한다.
  • Rest server는 다중 계층으로 구성될 수 있다.
    • 보안, 로드 밸런싱, 암호화 등을 위한 계층을 추가하여 구조를 변경할 수 있다.
    • Proxy, Gateway와 같은 네트워크 기반의 중간매체를 사용할 수 있다.
    • 하지만, Client는 server와 직접 통신하는지, 중간 서버와 통신하는지 알 수 없다.
• Uniform Interface(인터페이스 일관성)
  • URI로 지정한 Resource에 대한 요청을 통일되고, 한정적으로 수행하는 아키텍처 스타일을 의미합니다.
  • HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하며, Loosely Coupling(느슨한 결함) 형태를 갖습니다.
    • 즉, 특정 언어나 기술에 종속되지 않음
• Ser-Descriptiveness(자체 표현)
  • 요청 메시지만 보고도 쉽게 이해할 수 있는 자체 표현 구조로 되어있습니다.

 

▶️Rest API란?

• REST의 특징을 기반으로 서비스 API를 구현한 것
• URI는 정보의 자원만 표현해야 하며, 자원의 행위는 HTTP Method에 명시한다는 것입니다.

 

▶️Rest API 설계 시 가장 중요한 항목 두 가지

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

 

▶️Rest API 설계 규칙

• URI는 명사를 사용한다.(리소스명은 동사가 아닌 명사를 사용해야 한다.)
  •  아래와 같은 동사를 사용하지 말 것
    •  /getAllUsers
    • /getUserById
    • /createNewUser
    • /updateUser
    • /deleteUser
• URI 마지막 문자로 슬래시 ( / )를 포함하지 않는다.
• 밑줄( _ )을 사용하지 않고, 하이픈( - )을 사용한다.
• URI는 소문자로만 구성한다.
• HTTP 응답 상태 코드 사용
• 슬래시( / )로 계층 관계를 표현한다.
• 클라이언트는 해당 요청에 대한 실패, 처리완료 또는 잘못된 요청 등에 대한 피드백을 받아야 한다.
• 파일확장자는 URI에 포함하지 않는다.
  • ex)http://dev-coco.tistory.com/restapi/220/photo.jpg(X)