Post

REST API

REST API의 개념, 기본 원칙, 예제 포함 설명

REST(Representational State Transfer) API는 HTTP를 기반으로 클라이언트와 서버 사이의 상호작용을 구조화하는 API 설계 스타일입니다. 이번 포스트에서는 REST API의 개념과 기본 원칙을 예제를 통해 자세히 알아보겠습니다.

REST API의 기본 원칙

1. 자원(Resource)

REST API는 각 자원에 고유한 식별자(URI)를 부여합니다. 이 식별자는 해당 자원을 나타내며, 클라이언트는 URI를 통해 자원에 접근하고 조작할 수 있습니다.

예를 들어, 사용자 정보를 관리하는 REST API에서 사용자 목록을 조회하는 URI는 /users가 될 수 있으며, 특정 사용자를 조회하는 URI는 /users/{userId}와 같이 특정 ID를 포함합니다.

2. 행위(Verb)

HTTP 메소드(GET, POST, PUT, DELETE 등)를 사용하여 자원에 대한 행위를 정의합니다.

  • GET: 자원을 조회합니다. 예를 들어, /users를 GET 요청하면 모든 사용자 목록을 가져올 수 있습니다.
  • POST: 새로운 자원을 생성합니다. /users에 POST 요청을 보내면 새로운 사용자를 추가할 수 있습니다.
  • PUT: 자원을 수정합니다. /users/{userId}에 PUT 요청을 보내면 특정 사용자의 정보를 수정할 수 있습니다.
  • DELETE: 자원을 삭제합니다. /users/{userId}에 DELETE 요청을 보내면 특정 사용자를 삭제할 수 있습니다.

3. 표현(Representation)

REST API는 자원의 상태를 표현하는 방법을 정의합니다. 주로 JSON 형식을 사용하여 데이터를 전송하며, 클라이언트와 서버 간의 데이터 교환은 이러한 표현을 통해 이루어집니다.

예를 들어, 사용자 정보를 JSON 형식으로 표현한 예는 다음과 같습니다:

1
2
3
4
5
{
  "userId": 1,
  "username": "john_doe",
  "email": "john.doe@example.com"
}

4. 상태를 관리하지 않음(Stateless)

REST API는 상태를 관리하지 않습니다(Stateless). 즉, 클라이언트와 서버 간의 각 요청은 독립적이며, 서버는 클라이언트의 상태를 기억하지 않습니다. 이는 서버의 부담을 줄이고 확장성을 높이는 장점을 제공합니다.

5. 자유로운 형식(Uniform Interface)

REST API는 표준 HTTP 프로토콜을 기반으로 하여 클라이언트와 서버 사이의 인터페이스를 통일시킵니다. 이는 클라이언트와 서버가 각각 독립적으로 진화할 수 있는 유연성을 제공하며, API의 이해와 사용을 쉽게 만듭니다.

REST API 예제

다음은 간단한 사용자 정보를 관리하는 REST API의 예제입니다.

사용자 목록 조회

요청: GET /users 응답: HTTP 200 OK

1
2
3
4
5
6
7
8
9
10
11
12
13
[
  {
    "userId": 1,
    "username": "john_doe",
    "email": "john.doe@example.com"
  },
  {
    "userId": 2,
    "username": "jane_smith",
    "email": "jane.smith@example.com"
  }
]

사용자 추가

요청: POST /users

1
2
3
4
5
{
  "username": "alice_wonder",
  "email": "alice.wonder@example.com"
}

  • 응답: HTTP 201 Created

마무리

이와 같이 REST API는 자원, 행위, 표현, 상태를 관리하지 않음, 자유로운 형식의 원칙을 기반으로 설계되어 클라이언트와 서버 간의 효율적인 데이터 교환을 가능하게 합니다.

감사합니다.

This post is licensed under CC BY 4.0 by the author.