REST API란?

참고 블로그

https://meetup.toast.com/posts/92

REST API 제대로 알고 사용하기 : NHN Cloud Meetup

 

Representational State Transfer API

 

1. REST API란?

앱의 장점을 최대한 활용할 수 있는 아키텍처

---

2. REST 구성

자원 - URI

행위 - HTTP METHOD

표현

---

3. REST의 특징

1. 유니폼 인터페이스 (uniform interface)

uniform interface URI로 지정한 리소스에 대한 조작을 통일된 인터페이스로 수행하는 아키텍처 스타일

2. 무상태성(Stateless)

무상태성이란 작업을 위한 상태정보를 따로 저장하고 관리하지 않는다.

세션 정보나 쿠키정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들오는 요청만을 단순히 처리하면 된다.

그래서 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해진다.

3.캐시 가능(Cacheable)

기존 웹표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용이 가능하다.

따라서 HTTP가 가진 캐싱 기능이 적용 가능하다. HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.

4. 자체 표현 구조(Self-descriptiveness)

REST API 메시지만 보고도 이를 쉽게 이해 할 수 있는 자체 표현 구조로 되어 있다는 것.

5. 클라이언트-서버 구조

REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해진다. 서로간 의존성이 줄어들게 된다.

6. 계층형 구조

REST 서버는 다중 계층으로 구성될 수 있다. 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고

PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게 한다.

---

4. REST API 어떻게 만들까?

1. URI로 정보의 자원을 표현하기

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

 

4-1. REST API 중심 규칙

1) URI는 정보의 자원을 표현하기.(리소스명은 동사보다는 명사를 사용)

 

올바른 REST API 형식

GET /page/1

잘못된 REST API 형식

GET /page/delete/1

 

회원을 추가할 때

GET /member/insert/2 (x) > GET 메서드는 리소스 생성에 맞지 않습니다.
POST /member/2         (o)

 

+HTTP METHOD의 알맞은 역할

POST, GET, PUT, DELETE 이 4가지의 Method를 가지고 CRUD를 할 수 있습니다.

METHOD	역할
POST	POST를 통해 해당 URI를 요청하면리소스를 생성한다.
GET	GET를 통해 해당 리소스를 조회한다.
PUT	PUT를 통해 해당 리소스를 수정한다.
DELETE	DELETE를 통해 리소스를 삭제한다.

다음과 같은 식으로 URI는 자원을 표현하는 데에 집중하고 행위에 대한 정의는 HTTP METHOD를 통해 하는 것이 중심규칙입니다.

 

1. 슬래시 구분자를 계층 관계를 나타내는 데 사용하기

2.URI 마지막 문자로 슬래시(/) 포함하지 않기

3.하이픈(-)은 URI 가독성을 높이는데 사용하기

4.밑줄(_)은 URI에 사용하지 않기(문자와 혼동가능성있음. 가독성을 떨어뜨린다.)

5. URI경로는 소문자만 사용하기(RFC 3986 URI 문법 형식은 대소문자를 구별하기 때문)

6. 파일확장자는 URI에 포함시키지 않기(Accept header를 사용하기)

 

5. HTTP 응답 상태 코드

잘 설계된 REST API는 URI뿐만이 아니라 해당 리소스에 대한 응답을 잘 돌려주는 것까지 포함합니다.

 

상태코드
200	클라이언트의 요청을 정상적으로 수행함
201	클라이언트가 리소스 생성을 요청했을때 해당 리소스가 성공적으로 생성됨(POST를 통한 리소스 생성 작업 시)

 

상태코드
400	클라이언트의 요청이 부적절 할 경우 사용
401	클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때 (로그인 하지 않은 유저가 로그인 했을 때, 요청 가능한 리소스를 요청했을 때)
403	유저 인증상태와 관계 없이 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때 사용하는 응답 코드 (403보다는 400이나 404를 사용할 것을 권고. 403 자체가 리소스가 존재한다는 뜻이기 때문에)
405	클라이언트가 요청한 리소스에서는 사용 불가능한 Method를 이용했을 경우 사용하는 응답 코드

 

상태코드
301	클라이언트가 요청한 리소스에 대한 URI가 변경 되었을때 사용하는 응답 코드 (응답 시 Location header에 변경된 URI를 적어 줘야 함.)
500	서버에 문제가 있을 경우 사용하는 응답 코드