REST API란?
REST API란?
REST API는 Representational State Transfer (REST) 아키텍처 스타일을 따르는 API입니다. REST는 웹의 장점을 최대한 활용하기 위해 설계된 아키텍처 스타일로, RESTful API는 HTTP 프로토콜을 기반으로 클라이언트와 서버 간의 통신을 가능하게 합니다.
REST의 기본 원칙
- 자원(Resource): 모든 것은 자원으로 간주됩니다. 자원은 URI(Uniform Resource Identifier)를 통해 고유하게 식별됩니다.
- 표현(Representation): 클라이언트와 서버는 자원의 상태를 주고받을 때 JSON, XML 등의 형식을 사용하여 데이터를 주고받습니다.
- 상태 무관성(Stateless): 각 요청은 독립적이며, 요청 간에 클라이언트의 상태를 저장하지 않습니다. 서버는 각 요청을 별도로 처리하고, 필요한 모든 정보를 요청에 포함시켜야 합니다.
- 캐시 가능(Cacheable): HTTP 응답은 캐시가 가능하도록 설계될 수 있으며, 이를 통해 네트워크 트래픽을 줄이고 성능을 향상시킬 수 있습니다.
- 계층화 시스템(Layered System): 클라이언트는 중간 서버(프록시, 게이트웨이 등)를 통해 서버와 상호 작용할 수 있으며, 이러한 중간 서버는 로드 밸런싱, 캐싱 등의 기능을 수행할 수 있습니다.
- 인터페이스 일관성(Uniform Interface): 클라이언트와 서버 간의 인터페이스는 일관성을 유지해야 하며, 이는 REST API를 간단하고 이해하기 쉽게 만듭니다.
HTTP 메서드
REST API는 주로 HTTP 메서드를 사용하여 자원을 처리합니다. 주요 메서드는 다음과 같습니다.
- GET: 자원의 표현을 요청합니다. 데이터를 조회할 때 사용됩니다.
- POST: 새로운 자원을 생성합니다.
- PUT: 자원을 업데이트합니다. 자원이 존재하지 않으면 생성할 수도 있습니다.
- DELETE: 자원을 삭제합니다.
- PATCH: 자원의 부분적인 업데이트를 수행합니다.
HTTP 상태 코드
REST API는 HTTP 상태 코드를 사용하여 요청의 결과를 나타냅니다. 주요 상태 코드는 다음과 같습니다.
- 200 OK: 요청이 성공적으로 처리되었습니다.
- 201 Created: 자원이 성공적으로 생성되었습니다.
- 204 No Content: 요청이 성공적으로 처리되었으나, 반환할 내용이 없습니다.
- 400 Bad Request: 잘못된 요청입니다. 요청 구문, 메시지 등이 잘못되었습니다.
- 401 Unauthorized: 인증이 필요합니다.
- 403 Forbidden: 서버가 요청을 이해했지만, 권한 때문에 거부되었습니다.
- 404 Not Found: 요청한 자원을 찾을 수 없습니다.
- 500 Internal Server Error: 서버에 오류가 발생하여 요청을 처리할 수 없습니다.
REST API의 설계 원칙
- 명사 사용: 엔드포인트는 명사를 사용하여 자원을 나타내야 합니다. 예를 들어,
/users는 사용자 목록을,/orders는 주문 목록을 나타냅니다. - 엔드포인트의 계층 구조: 자원 간의 관계를 반영하도록 엔드포인트를 계층 구조로 설계합니다. 예를 들어,
/users/{userId}/orders는 특정 사용자의 주문을 나타냅니다. - HTTP 메서드 사용: 자원의 작업을 나타내기 위해 적절한 HTTP 메서드를 사용합니다. 예를 들어, 데이터를 조회하려면 GET을, 삭제하려면 DELETE를 사용합니다.
- 상태 코드 사용: 클라이언트가 요청의 결과를 이해할 수 있도록 적절한 HTTP 상태 코드를 반환합니다.
예제
다음은 간단한 REST API의 예제입니다:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
GET /users
200 OK
[
{
"id": 1,
"name": "John Doe"
},
{
"id": 2,
"name": "Jane Doe"
}
]
POST /users
Request Body:
{
"name": "New User"
}
201 Created
{
"id": 3,
"name": "New User"
}
GET /users/3
200 OK
{
"id": 3,
"name": "New User"
}
PUT /users/3
Request Body:
{
"name": "Updated User"
}
200 OK
{
"id": 3,
"name": "Updated User"
}
DELETE /users/3
204 No Content
이 예제는 사용자 정보를 관리하는 간단한 REST API의 엔드포인트와 HTTP 메서드의 사용법을 보여줍니다.
This post is licensed under CC BY 4.0 by the author.
