REST한 형식의 API
요청방식에 대한 약속
REST하지 않은 형식
https://(사이트주소)/1 --> 상영중 영화목록 요청 GET
https://(사이트주소)/2 --> 내일 오픈예정 영화 목록 GET
https://(사이트주소)/3 --> 실시간 영화 관객 순위 GET
https://(사이트주소)/4 --> 영화 예약 POST
1, 2, 3, 4...이렇게 하면 헷갈린다. 만약 서버 담당자가 퇴사를 하거나, 정보가 누락될 시 어떤게 각 주소가 어떤 API이지 알기 힘들고 실수할 가능성이 높다.
그래서 명사형으로 작성을 하자!
REST한 형식
https://(사이트주소)/moviewlists --> 상영중 영화목록 요청 GET
https://(사이트주소)/moviewlists?open=tomorrow --> 내일 오픈예정 영화 목록 GET
https://(사이트주소)/moviewlists-reservation --> 영화 예약 POST
명사형으로 작성하면 딱 보고 어떤 API인지 쉽게 알 수 있다.
이런게 REST한 형식의 API라고 한다.
REST 구성
RESTAPI는 다음과 같은 구성으로 이루어져있다.
- 자원(RESOURCE) - URI
- 행위(Verb) - HTTP METHOD
- 표현(Representations)
METHOD 역할
| POST | POST를 통해 해당 URI를 요청하면 리소스를 생성합니다. |
| GET | GET를 통해 해당 리소스를 조회합니다. 리소스를 조회하고 해당 도큐먼트에 대한 자세한 정보를 가져온다. |
| PUT | PUT를 통해 해당 리소스를 수정합니다. |
| DELETE | DELETE를 통해 리소스를 삭제합니다. |
HTTP 응답 상태 코드
상태코드
| 200 | 클라이언트의 요청을 정상적으로 수행함 |
| 201 | 클라이언트가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성됨(POST를 통한 리소스 생성 작업 시) |
| 400 | 클라이언트의 요청이 부적절 할 경우 사용하는 응답 코드 |
| 401 | 클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때 사용하는 응답 코드 |
| (로그인 하지 않은 유저가 로그인 했을 때, 요청 가능한 리소스를 요청했을 때) | |
| 403 | 유저 인증상태와 관계 없이 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때 사용하는 응답 코드 |
| (403 보다는 400이나 404를 사용할 것을 권고. 403 자체가 리소스가 존재한다는 뜻이기 때문에) | |
| 405 | 클라이언트가 요청한 리소스에서는 사용 불가능한 Method를 이용했을 경우 사용하는 응답 코드 |
| 301 | 클라이언트가 요청한 리소스에 대한 URI가 변경 되었을 때 사용하는 응답 코드 |
| (응답 시 Location header에 변경된 URI를 적어 줘야 합니다.) | |
| 500 | 서버에 문제가 있을 경우 사용하는 응답 코드 |
REST의 특징
1) Uniform(유니폼 인터페이스)
Uniform Interface는 URI로 지정한 리소스에 대한동작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일을 말한다.
2) Stateless(무상태성)
REST는 무상태성인 성격을 갖는다. 작업을 위한 상태정보를 따로 저장하고 관리하지 않는다. 세션 정보나 쿠키정보를 별도로 저장하고 관리하지 않기 때문에 API서버는 요청만을 단순히 처리하면 된다. 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해진다.
3) Cacheable(캐시가능)
REST의 가장 큰 특징중 하나는 HTTP라는 기존 웹 표준을 그대로 사용하기 떄문에, 웹에서 사용하는 기존 인프라를 그대로 활용이 가능해진다. 따라서 HTTP가 가진 캐싱 기능이 적용가능하다. HTTP프로토콜 표준에서 사용하는 Last-Modified태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.
4) Self-descriptiveness(자체 표현 구조)
REST의 또다른 큰 특징 중 하나는 RESTAPI메시지만 보고 이를 쉽게 이해할 수 있는 자체 표현 구조로 되어있다.
5) Client - Server구조
REST서버는 API제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을 직접 관리하는 구조로 각각의 역할이 확실히 구분도기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어딜게된다.
6) 계층형 구조
REST서버는 다중계층으로 구성될 수 있으며, 보안, 로드밸런싱, 암호화계층을 추가해 구조상의 유연성을 둘 수 있고, PROXY, 게이트웨이같은 네트워크 기반의 중간매체를 사용할 수 있게된다.