태인의 Blog/
REST API 알아보기
Forest
REST API 알아보기

REST API 알아보기

작성자
태인태인
카테고리
📗 스터디
작성일
2020년 12월 12일
태그
Web

REST API?

REST는 Representational State Transfer라는 용어의 약자이다. HTTP의 주요 저자 중 한 사람인 로이 필딩은 웹의 장점을 최대한 활용할 수 있는 아키텍처로써 REST를 발표했다.

구성

REST API는 다음의 구성으로 이루어져있다.
자원(RESOURCE) - URI 행위(Verb) - HTTP METHOD 표현(Representations)

특징

  1. Uniform (유니폼 인터페이스) Uniform Interface는 URI로 지정한 리소스에 대한 조작이 통일되고 한정적인 인터페이스로 수행한다.
  1. Stateless (무상태성) 세션 정보나 쿠키정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 돼 구현이 단순하다.
  1. Cacheable (캐시 가능) HTTP라는 기존 웹표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용이 가능하다.
  1. Self-descriptiveness (자체 표현 구조) REST API 메시지만 보고도 이를 쉽게 이해 할 수 있는 자체 표현 구조로 이루어져 있다.
  1. Client - Server 구조 REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을 직접 관리하는 구조로 각각의 역할이 명확하게 구분된다.
  1. 계층형 구조 REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용가능하다.

설계 규칙

먼저 가장 중요한 규칙은 다음 두 가지이다.

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

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

  1. URI는 정보의 자원을 표현해야 한다. 예를 통해 알아보자.
GET /members/delete/1
위 코드는 나쁜 예이다. URI에는 delete와 같은 행위 표현이 들어가면 안된다. 위의 URI를 HTTP Method를 통해 수정하면 아래와 같다.
DELETE /members/1
이러한 방식으로 어떤 데이터를 가져올 때는 GET, 추가 작업을 할 때는 POST 등을 사용하면 된다.
  • POST - POST를 통해 해당 URI를 요청하면 리소스를 생성합니다.
  • GET - GET를 통해 해당 리소스를 조회합니다. 리소스를 조회하고 해당 도큐먼트에 대한 자세한 정보를 가져온다.
  • PUT - PUT를 통해 해당 리소스를 수정합니다.
  • DELETE - DELETE를 통해 리소스를 삭제합니다.
  1. 슬래시 구분자(/)는 계층 관계를 나타내는 데 사용된다.
  1. URI 마지막 문자로 슬래시(/)를 포함하지 않는다.
<http://example.com/foods/fruits/> (X)
<http://example.com/foods/fruits>  (O)
  1. 하이픈(-)은 URI 가독성을 높이는데 사용 URI를 쉽게 읽고 해석하기 위해, 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높일 수 있다.
  1. 밑줄(_)은 URI에 사용하지 않는다. 가독성 문제를 방지하기 위해 밑줄 대신 하이픈(-)을 사용하는 것이 좋다.
  1. URI 경로에는 소문자가 적합하다. URI 경로에 대문자 사용은 피한다. 대소문자에 따라 다른 리소스로 인식하게 되기 때문이다.
  1. 파일 확장자는 URI에 포함시키지 않는다.
<http://example.com/foods/fruits/apple/photo.jpg> (X)
이 경우 Accept header를 사용한다.
GET / foods/fruits/apple/photo HTTP/1.1 Host: example.com Accept: image/jpg
  1. REST 리소스 간에는 연관 관계가 있을 수 있다.
/리소스명/리소스 ID/관계가 있는 다른 리소스명
일반적으로 소유 ‘has’의 관계를 표현할 때 아래와 같이 구현한다.
GET : /users/{userid}/devices
  1. 자원을 표현하는 Colllection과 Document Document는 단순히 문서로 이해해도 되고, 한 객체라고 이해해도 된다. Colllection은 문서들의 집합, 객체들의 집합이라고 생각할 수 있다. 컬렉션과 도큐먼트는 모두 리소스라고 표현할 수 있으며 URI에 표현된다
<http://example.com/fruits/apple>
위 URI에서 fruits 컬렉션과 apple 도큐먼트로 표현되고 있다고 생각할 수 있다.

HTTP 응답 상태 코드

  • 200 - 클라이언트의 요청을 정상적으로 수행함
  • 201 - 클라이언트가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성됨(POST를 통한 리소스 생성 작업 시) 상태코드
  • 400 - 클라이언트의 요청이 부적절 할 경우 사용하는 응답 코드
  • 401 - 클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때 사용하는 응답 코드 (로그인 하지 않은 유저가 로그인 했을 때, 요청 가능한 리소스를 요청했을 때)
  • 403 - 유저 인증상태와 관계 없이 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때 사용하는 응답 코드 (403 보다는 400이나 404를 사용할 것을 권고. 403 자체가 리소스가 존재한다는 뜻이기 때문에)
  • 405 - 클라이언트가 요청한 리소스에서는 사용 불가능한 Method를 이용했을 경우 사용하는 응답 코드 상태코드
  • 301 - 클라이언트가 요청한 리소스에 대한 URI가 변경 되었을 때 사용하는 응답 코드 (응답 시 Location header에 변경된 URI를 적어 줘야 한다.)
  • 500 - 서버에 문제가 있을 경우 사용하는 응답 코드

댓글

guest