REST API, HTTP Methods

yeji·2021년 1월 28일

REST API

REST란?

Representational State Transfer API 용어의 약자로, HTTP의 장점을 최대한 활용할 수 있는 아키텍처인 REST

REST 아키텍처의 구성 3요소

Resource - URI
Verb - HTTP Method
Representations

REST의 특징

Uniform (유니폼 인터페이스)
URI로 지정한 리소스에 대한 조직을 통일된 인터페이스로 수행하는 아키텍처 스타일
Stateless (무상태성)
상태정보(세션 정보나 쿠키 정보 등)를 별도로 저장하거나 관리하지 않기에 API서버는 들어오는 요청만을 단순히 처리하면 된다.
서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해지는 장점
Cacheable (캐시 가능)
REST의 가장 큰 특징 중 하나는 HTTP라는 기존 웹표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용할 수 있다. 따라서 HTTP가 가진 캐싱 기능 그대로 사용 가능
HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현 가능
Self-descriptiveness (자체 표현 구조)
REST API 메시지만 보고도 이를 쉽게 이해할 수 있는 자체 표현 구조이다.
Client - Server 구조
REST서버는 API제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을 직접 관리하는 구조로 각각의 역할이 확실히 구분된다. 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어드는 장점
계층형 구조
REST서버는 다중 계층으로 구성될 수 있으며 보안, 로드밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게 합니다.

REST API 디자인 가이드

1. URI는 정보의 Resource(자원)를 표현!

ex. 회원 삭제 : DELETE /members/1 (⭕), GET /members/delete/1 (❌)
ex. 회원 조회 : GET /members/1 (⭕), GET /members/show/1 (❌)
ex. 회원 추가 : POST /members/2 (⭕), GET /members/insert/2 (❌)
위와 같이 행위에 대한 표현 없이 URI를 구성!

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

HTTP Method의 알맞은 역할

HTTP Method의 역할을 잘 구분하여 사용하는 것이 바로 RESTful API 이다!

Method	역할
POST	해당 URI를 요청하여 Resource를 생성
GET	해당 Resource를 조회, 해당 도큐먼트에 대한 자세한 정보 가져옴
PUT	해당 Resource 수정 (존재하지 않는 URI에 PUT 요청시 "생성"도 가능)
DELETE	해당 Resource 삭제

URI 설계 시 주의할 점

슬래시(/)는 계층 관계를 나타내는 데 사용!
- ex. http://restapi.example.com/houses/apartments
- ex. http://restapi.example.com/animials/mammals/whales
URI의 마지막 문자로 슬래시(/) 포함 X!
URI에 하이픈(-) 사용!
- 가독성 높이는 방법
URI에 밑줄(_) 사용 X!
- 밑줄은 안보일 수도 있기에 가독성 나빠짐
URI 경로는 소문자 사용!
- 대소문자에 따라 다른 리소스로 인식하기 때문
파일 확장자는 URI에 포함 X!
- 대신 Accept header를 사용하자!

Resource 간 관계 표현

has 관계
ex. /리소스명/리소스ID/관계가 있는 다른 리소스명
-> GET : /users/{userid}/devices
관계명이 복잡하다면? 서브 리소스에 명시적으로 표현
ex. 사용자가 '좋아하는' 디바이스 목록 표현하는 경우
-> GET : /users/{userid}/likes/devices

Resource 표현 (Document와 Collection)

Document : 하나의 문서, 하나의 객체
Collection : 문서들의 집합, 객체들의 집합

Document와 Collection은 모두 Resource이고 URI에 표현된다!
Collection은 복수로 사용 가능하다!

ex. sports라는 collection과 soccer라는 document
-> http://restapi.example.com/sports/soccer
ex. sports, players collection(복수 가능)과 soccer, 13번선수 document
-> http://restapi.example.com/sports/soccer/players/13

RESTful API 사용

1. Query String

리소스들을 정렬, 필터링, 페이징하는 곳에 사용
parameter들을 ?와 &을 이용하여 작성
/board/list?writer=john -> writer가 john인 게시글들을 모두 가져오기

2. Path Variable

구체적으로 리소스를 식별하는데 사용
{}나 :을 사용하여 작성
/board/12 -> id가 12인 게시글 하나 가져오기

HTTP 응답 상태 코드

상태 코드	내용
2xx	===== 성공 =====
`200`	client의 요청을 정상적으로 수행
`201`	client가 POST로 어떠한 resource 생성을 요청, 해당 resource가 성공적으로 생성됨
3xx	===== 리다이렉션 완료 (클라이언트의 추가 동작 필요) =====
`301`	client가 요청한 resouce에 대한 URI가 변경 되었을 때 (응답 시 location header에 변경된 URI를 기입 필요)
4xx	===== client 오류 =====
`400`	client의 요청이 부적절, 서버가 요청의 구문을 인식하지 못했다.
`401`	인증 실패, client가 인증되지 않은 상태에서 보호된 resource를 요청 (로그인 하지 않은 유저가 로그인 했을 때, 요청 가능한 resource를 요청했을 때
`403`	인가 실패로 접근 거부, 유저 인증상태와 관계 없이 응답하고 싶지 않은 resource를 client가 요청했을 때
`404`	resource를 찾을 수 없음, client가 존재하지 않는 resouce를 요청했을 때
`405`	client가 요청한 resource에서는 사용 불가능한 method를 이용했을 경우
5xx	===== server 오류 =====
`500`	내부 server에 문제가 있을 때
`503`	서비스 불가능 (일반적으로 proxy 장비에서 서버에 서비스가 불가능할 때 띄움)