RESTful API 에 대해 알아보자!

REST API 란?

REST의 구성

1. 자원 (Resource) - URL
자원에는 고유한 리소스 식별자가 있고, 이는 서버에 있다. 이 자원을 구별하는 것을 바로 URI 라고 부른다.

2. 행위 (Verb) - HTTP Method
행위는 자원이 어떠한 동작을 수행할 지를 나타내는 것으로, 대표적으로 GET, POST, PUT, DELETE 를 사용한다.
• GET: 자원 조회
• POST: 자원 생성
• PUT: 자원 수정
• DELETE: 자원 삭제

3. 표현 (Representations)
클라이언트가 자원의 상태에 대한 조작을 요청하면 서버는 이에 대해 응답을 `JSON`, `XML` 등의 형태로 보내준다.

REST의 특징

1. Server-Client (서버/클라이언트 구조)

2. Stateless (무상태성)

3. Cacheable (캐시 처리 가능)

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

5. Layered System (계층화)

6. Uniform Interface (인터페이스 일관성)

REST 장단점

장점

• HTTP 프로토콜을 이용하므로 별도의 인프라 구축이 필요없다.

• HTTP 프로토콜을 사용하는 플랫폼에서는 모두 사용 가능하다.

• 서버와 클라이언트의 역할을 명확하게 분리한다.

단점

• 표준이 존재하지 않아 별도로 정의가 필요하다.

• HTTP 프로토콜에 의존적이다.

• CRUD 4가지 형태의 메소드만 제공한다.

RESTful API 란?

RESTful API 개발 원칙

1. 자원을 식별할 수 있어야 한다. 이 때 자원의 식별은 URI를 통해 한다.

2. 행위는 HTTP 메소드를 통해 표현한다. GET, POST, PUT, DELETE 등이 사용된다.

3. 메시지는 자기 서술적이어야 한다. 메시지 포맷과 HTTP 메소드를 통해 요청의 의도를 표현할 수 있어야 한다.

4. 애플리케이션의 상태는 Hypermedia를 통해 관리한다. Hypermedia 링크를 통해 애플리케이션의 상태를 전환할 수 있어야 한다.

RESTful API 사용 사례

• POST 블로그 포스팅 생성
• Request

POST http://blog.com/post
Body:
{
  "post": {
    "title": "RESTful 에 대해 알아보자!",
    "contents": "REST API는 ...",
    "author": "Daniel",
    ...
  }
}

• Response

Status Code: 201 CREATED
Content-Type: application/json

{
  "errMsg": "Success"
}

• GET 블로그 포스팅 조회
• Request

GET http://blog.com/post/1

• Response

Status Code: 200 OK
Content-Type: application/json

"errMsg": "Success",
"post": {
  "title": "RESTful 에 대해 알아보자!",
  "contents": "REST API는 ...",
  "author": "Daniel",
  ...
}

• PUT 블로그 포스팅 수정
• Request

PUT http://blog.com/post/1
Body:
{
  "post": {
    "title": "RESTful 에 대해 알아보자!(2)",
    "contents": "REST API는 ...",
    "author": "Daniel",
    ...
  }
}

• Response

Status Code: 200 OK
Content-Type: application/json

"errMsg": "Success"

• DELETE 블로그 포스팅 삭제
• Request

DELETE http://blog.com/post/1

• Response

Status Code: 200 OK
Content-Type: application/json

"errMsg": "Success"

결론