HTTP 요청과 응답에 대해 알아보기: REST API 개념 이해하기 (3/3)

2023.04.24 - [프로그래밍/JAVA 프로그래밍] - HTTP 요청과 응답에 대해 알아보기: REST API 개념 이해하기 (1/3)

2023.04.25 - [프로그래밍/JAVA 프로그래밍] - HTTP 요청과 응답에 대해 알아보기: REST API 개념 이해하기 (2/3)

이전 글에서는 REST API의 개념과 구성 요소를 살펴보았습니다.

이번 글에서는 RESTful API 디자인에 대한 가이드를 제공하겠습니다.

 

RESTful API 디자인은 특정한 규칙에 따라야 하며, 이를 따르면 클라이언트-서버 간의 통신이 효율적이고 일관성 있게 이루어집니다.

 

RESTful API 디자인 가이드

URI 설계

URI는 RESTful API에서 가장 중요한 구성 요소 중 하나입니다.

URI는 리소스의 경로와 쿼리 파라미터로 구성되며, 클라이언트는 URI를 사용하여 서버에서 리소스를 가져오거나 조작합니다.

RESTful API에서 URI를 설계할 때는 다음 가이드를 따르는 것이 좋습니다.

 

• 리소스는 명사로 표현합니다. 예를 들어, https://example.com/api/books와 같이 리소스를 나타내는 URI는 동사가 아닌 명사로 표현됩니다.
• 리소스를 식별하는 정보는 경로에 포함됩니다. 예를 들어, https://example.com/api/books/1 URI는 ID가 1인 책을 나타냅니다.
• 리소스 간의 관계는 경로에 반영됩니다. 예를 들어, https://example.com/api/books/1/chapters/2 URI는 ID가 1인 책의 두 번째 챕터를 나타냅니다.

 

HTTP 메서드

HTTP 메서드는 RESTful API에서 리소스를 조작하는 데 사용됩니다.

HTTP 메서드를 사용할 때는 다음 가이드를 따르는 것이 좋습니다.

 

• GET: 서버에서 리소스를 가져올 때 사용됩니다. GET 요청은 URI에 지정된 리소스의 표현을 요청합니다.
• POST: 서버에 데이터를 전송하여 새로운 리소스를 생성할 때 사용됩니다. POST 요청은 요청 본문에 데이터를 포함합니다.
• PUT: 서버에 데이터를 전송하여 리소스를 수정할 때 사용됩니다. PUT 요청은 URI에 지정된 리소스를 요청 본문에 포함된 표현으로 대체합니다.
• DELETE: 서버에서 리소스를 삭제할 때 사용됩니다. DELETE 요청은 URI에 지정된 리소스를 삭제합니다. 

 

페이로드

RESTful API의 페이로드는 JSON, XML 등의 형식으로 전송됩니다.

페이로드를 설계할 때는 다음 가이드를 따르는 것이 좋습니다.

 

• 페이로드는 가능한 한 간결하게 설계합니다. 클라이언트가 불필요한 데이터를 수신하지 않도록 주의해야 합니다.
• 페이로드는 응답 메시지에 포함됩니다. 응답 메시지의 헤더는 페이로드의 형식을 지정합니다.

 

HTTP 상태 코드

HTTP 상태 코드는 RESTful API에서 클라이언트-서버 간의 통신을 성공적으로 처리했는지 나타냅니다.

상태 코드는 1xx(정보), 2xx(성공), 3xx(리다이렉션), 4xx(클라이언트 오류), 5xx(서버 오류) 등 다양한 범주로 구분됩니다.

RESTful API에서는 주로 다음 상태 코드를 사용합니다.

 

• 200 OK: 요청이 성공적으로 처리되었으며, 응답 본문에 데이터가 포함됩니다.
• 201 Created: 새로운 리소스가 성공적으로 생성되었으며, 응답 본문에 생성된 리소스의 URI가 포함됩니다.
• 204 No Content: 요청이 성공적으로 처리되었으며, 응답 본문에 데이터가 없습니다.
• 400 Bad Request: 잘못된 요청이 전송되었습니다. 클라이언트는 요청을 수정하여 다시 보내야 합니다.
• 401 Unauthorized: 요청에 인증 정보가 없거나 유효하지 않습니다. 클라이언트는 인증 정보를 포함하여 요청을 다시 보내야 합니다.
• 404 Not Found: 요청한 리소스를 찾을 수 없습니다.

 

보안

RESTful API에서 보안은 매우 중요합니다.

API를 보호하기 위해 다음 가이드를 따르는 것이 좋습니다.

 

• HTTPS 프로토콜을 사용하여 데이터를 암호화합니다.
• 인증 정보는 HTTP 요청 헤더에 포함되어야 합니다.
• 사용자가 입력한 데이터는 입력값 검증을 거쳐야 합니다.

 

결론

RESTful API를 디자인할 때는 URI, HTTP 메서드, 페이로드, HTTP 상태 코드, 보안 등을 고려해야 합니다.

RESTful API를 잘 디자인하면 클라이언트와 서버 간의 통신이 효율적이고 일관성 있게 이루어질 수 있습니다.

이번 글에서는 RESTful API 디자인 가이드를 제공했습니다.