현대적인 웹 애플리케이션 개발에서 API(Application Programming Interface)는 클라이언트와 서버 간의 데이터 통신을 가능하게 하는 핵심적인 요소입니다. 특히 RESTful API는 웹 서비스의 표준으로 자리 잡으면서, 간결하고 직관적인 방식으로 데이터를 주고받을 수 있는 강력한 방법론을 제공합니다.
REST(Representational State Transfer)는 웹의 리소스를 HTTP 메서드(GET, POST, PUT, DELETE 등)를 통해 처리하는 아키텍처 스타일입니다. 이 방식은 애플리케이션이 서로 독립적으로 동작하면서도 데이터를 쉽게 교환할 수 있게 해줍니다. 예를 들어, 프론트엔드 애플리케이션, 모바일 앱, 심지어 외부 서비스도 RESTful API를 사용하여 서버와 통신할 수 있습니다.
이번 포스트에서는 RESTful API의 기본 개념을 설명하고, 스프링 부트를 사용해 실제로 RESTful API를 구축하는 방법을 살펴보겠습니다. 스프링 부트의 강력한 기능을 통해 간단한 API를 쉽게 만들고, JSON 형식으로 데이터를 주고받는 과정을 단계별로 알아볼 예정입니다.
1. RESTful API의 기본 개념
RESTful API는 REST(Representational State Transfer) 아키텍처 스타일을 기반으로 클라이언트와 서버가 데이터를 주고받는 방식입니다. RESTful API는 웹 상에서 리소스를 효율적으로 관리하고, HTTP 프로토콜을 기반으로 동작하는 특징이 있습니다. 여기서는 RESTful API의 핵심 개념과 원칙에 대해 설명합니다.
1-1. 리소스 기반 설계
REST는 모든 것을 리소스(Resource)로 간주합니다. 리소스는 서버가 관리하는 데이터를 의미하며, 각 리소스는 고유한 URI(Uniform Resource Identifier)를 통해 식별됩니다. RESTful API는 특정 리소스에 접근할 수 있는 경로(엔드포인트)를 제공합니다.
예를 들어,
GET /users: 모든 사용자 정보를 가져오는 요청GET /users/{id}: 특정 ID를 가진 사용자의 정보를 가져오는 요청POST /users: 새로운 사용자를 생성하는 요청PUT /users/{id}: 특정 ID의 사용자의 정보를 업데이트하는 요청DELETE /users/{id}: 특정 ID의 사용자를 삭제하는 요청
이와 같이, RESTful API에서는 URI를 통해 리소스를 명확하게 식별하고 관리합니다.
1-2. 무상태성 (Statelessness)
RESTful API는 무상태성(stateless) 원칙을 따릅니다. 즉, 서버는 클라이언트의 이전 요청에 대한 상태를 저장하지 않습니다. 각 요청은 독립적으로 처리되며, 요청 간의 상태를 유지하지 않으므로 서버의 부담을 덜어줍니다. 클라이언트는 필요한 모든 정보를 요청에 포함시켜야 하며, 서버는 해당 요청에 따라 바로 응답을 줍니다.
예를 들어, 클라이언트가 로그인 상태를 유지하기 위해 매번 인증 토큰을 요청 헤더에 포함시켜야 합니다. 서버는 이 토큰을 통해 클라이언트를 식별하지만, 이전 요청의 상태를 기억하지는 않습니다.
1-3. HTTP 메소드
RESTful API는 HTTP 메소드를 사용하여 리소스에 대한 작업을 정의합니다. 각 메서드는 특정한 목적을 가지고 있으며, 요청을 보낼 때 어떤 작업을 하고 싶은지를 명확하게 나타냅니다.
다음은 주요 HTTP메소드와 그 역할입니다.
- GET : 서버에서 리소스를 조회합니다. 데이터를 가져오기 위한 요청이며, 서버의 상태를 변경하지 않습니다.
- POST : 서버에 새로운 리소스를 생성합니다. 예를 들어, 새로운 사용자 정보를 서버에 추가할 때 사용합니다.
- PUT : 서버에서 기존 리소스를 업데이트합니다. 전체 데이터를 수정할 때 사용되며, 클라이언트는 수정된 전체 데이터를 전달해야 합니다.
- PATCH : 기존 리소스의 일부만 업데이트합니다. PUT과 달리 전체 데이터가 아닌, 일부 데이터만 수정합니다.
- DELETE : 서버에서 리소스를 삭제합니다.
1-4. 클라이언트-서버 간의 역할 분리
RESTful 아키텍처에서는 클라이언트와 서버가 명확하게 분리됩니다. 클라이언트는 사용자 인터페이스(UI)와 관련된 작업을 처리하고, 서버는 데이터 저장 및 비즈니스 로직을 처리하는 역할을 맡습니다. 클라이언트와 서버는 API를 통해 데이터를 주고받으며, 클라이언트는 서버의 내부 구조를 알 필요가 없습니다.
이러한 분리는 애플리케이션의 유연성을 높이고, 클라이언트와 서버의 독립적인 발전을 가능하게 합니다. 예를 들어, 웹 애플리케이션의 UI가 변경되어도 서버의 데이터 처리 로직은 변경할 필요가 없습니다.
1-5. 표현의 일관성 (Uniform Interface)
RESTful API는 일관된 인터페이스를 제공합니다. 즉, 동일한 URI와 메서드를 사용하여 클라이언트는 일관되게 서버에 접근할 수 있습니다. 이러한 일관성은 개발자가 API를 더 쉽게 이해하고 사용할 수 있게 합니다.
예를 들어, /users라는 경로는 언제나 사용자 리소스를 의미하고, GET /users는 항상 사용자 목록을 반환합니다. 이러한 일관성 덕분에 RESTful API는 예측 가능하고 쉽게 사용할 수 있습니다.
1-6. JSON 형식으로 데이터 교환
RESTful API에서는 데이터 교환을 위해 JSON형식을 주로 사용합니다. JSON은 경량의 데이터 포맷으로, 서버와 클라이언트 간에 데이터를 쉽게 주고받을 수 있게 해줍니다. JSON은 간결하면서도 구조화된 데이터를 표현할 수 있어, RESTful API와 잘 맞습니다.
{
"id": 1,
"name": "Federico",
"email": "Federico@example.com"
}이와 같이, RESTful API는 리소스 기반 설계, 무상태성, HTTP 메서드를 활용한 일관된 인터페이스를 통해 클라이언트-서버 간의 효율적인 데이터 통신을 가능하게 합니다. 이제 이러한 개념을 바탕으로, 스프링 부트를 사용하여 실제로 RESTful API를 구축하는 방법을 알아보겠습니다.
2.스프링 부트에서 RESTful API 구축
스프링 부트는 RESTful API를 쉽게 구현할 수 있는 다양한 기능을 제공합니다. RESTful API를 구축할 때 주로 사용하는 어노테이션들과 HTTP 메서드를 처리하는 방법을 알아보겠습니다.
2-1. @RestController 와 @RequestMapping
@RestController: 스프링 부트에서 RESTful API를 만들기 위해서는 @RestController 어노테이션을 사용합니다. 이는 해당 클래스가 REST API 요청을 처리하는 컨트롤러임을 나타내며, JSON 형식으로 데이터를 반환할 수 있습니다.@RequestMapping: API 엔드포인트를 정의할 때 사용되는 어노테이션으로, 특정 URL 경로와 HTTP 메서드를 매핑합니다. 이를 통해 API 요청을 처리할 수 있습니다.
@RestController
@RequestMapping("/api/users") // 이 클래스는 /api/users로 들어오는 요청을 처리
public class UserController {
@GetMapping
public List<User> getUsers() {
// 모든 사용자 목록을 반환하는 로직
return userService.findAllUsers();
}
@PostMapping
public User createUser(@RequestBody User user) {
// 새로운 사용자 생성 로직
return userService.saveUser(user);
}
@PutMapping("/{id}")
public User updateUser(@PathVariable Long id, @RequestBody User user) {
// 사용자 정보 수정 로직
return userService.updateUser(id, user);
}
@DeleteMapping("/{id}")
public void deleteUser(@PathVariable Long id) {
// 사용자 삭제 로직
userService.deleteUser(id);
}
}이 예제에서는 /api/users 경로에 매핑된 여러 HTTP 메서드(GET, POST, PUT, DELETE)를 처리하는 엔드포인트를 정의하고 있습니다. 이를 통해 사용자 목록 조회, 사용자 생성, 수정, 삭제와 같은 작업을 수행할 수 있습니다.
2-2. HTTP 메소드 매핑
스프링 부트에서는 HTTP 메소드에 따라 요청을 처리할 수 있습니다. 주로 사용하는 어노테이션은 다음과 같습니다.
@GetMapping: 데이터를 조회하는 GET 요청을 처리합니다.@PostMapping: 새로운 데이터를 생성하는 POST 요청을 처리합니다.@PutMapping: 기존 데이터를 수정하는 PUT 요청을 처리합니다.@DeleteMapping: 데이터를 삭제하는 DELETE 요청을 처리합니다.
각 메서드는 엔드포인트를 설정하고, 요청 데이터를 처리하거나, 서버에서 데이터를 반환하는 역할을 합니다.
2-3. @RequestBody와 @PathVariable 사용
@RequestBody: 클라이언트에서 보내는 JSON 데이터를 객체로 변환합니다. 주로 POST나 PUT 요청에서 데이터를 서버로 전송할 때 사용됩니다.@PathVariable: URL 경로에 포함된 변수 값을 받아옵니다. 예를 들어, /users/1에서 1이라는 값을 받아오는 데 사용됩니다.
@PostMapping("/create")
public User createUser(@RequestBody User user) {
return userService.saveUser(user); // RequestBody로 전달된 JSON 데이터를 User 객체로 변환
}
@PutMapping("/{id}")
public User updateUser(@PathVariable Long id, @RequestBody User user) {
return userService.updateUser(id, user); // 경로의 id를 받아와서 해당 사용자 업데이트
}이제 RESTful API를 스프링 부트로 구축하는 방법을 알았으니, 이를 바탕으로 간단한 CRUD API 예제를 만들어 보겠습니다.
3.간단한 CRUD API 예제
이제 사용자 정보를 관리하는 간단한 CRUD(Create, Read, Update, Delete) API를 만들어 보겠습니다. 이 API는 사용자 목록을 조회하고, 새로운 사용자를 추가하고, 사용자의 정보를 수정하고, 삭제하는 기능을 포함합니다.
3-1. 사용자 엔티티 생성
먼저, 사용자 정보를 저장하는 User 클래스를 정의합니다. 이 클래스는 데이터베이스에 저장되는 사용자 정보를 담고 있습니다.
@Entity
public class User {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
private String name;
private String email;
// Getter, Setter, 생성자 등 생략
}
3-2. 사용자 리포지토리 인터페이스
다음으로, 사용자 데이터를 처리할 UserRepository 인터페이스를 정의합니다. 이는 데이터베이스와 상호작용하며, 기본적인 CRUD 작업을 지원합니다.
public interface UserRepository extends JpaRepository<User, Long> {
}3-3. 사용자 서비스 로직
사용자 데이터를 처리하는 비즈니스 로직을 포함한 UserService 클래스를 작성합니다. 여기서는 사용자 목록 조회, 생성, 수정, 삭제 등의 작업을 정의합니다.
@Service
public class UserService {
@Autowired
private UserRepository userRepository;
public List<User> findAllUsers() {
return userRepository.findAll();
}
public User saveUser(User user) {
return userRepository.save(user);
}
public User updateUser(Long id, User updatedUser) {
User existingUser = userRepository.findById(id).orElseThrow();
existingUser.setName(updatedUser.getName());
existingUser.setEmail(updatedUser.getEmail());
return userRepository.save(existingUser);
}
public void deleteUser(Long id) {
userRepository.deleteById(id);
}
}
3-4. 사용자 컨트롤러 정의
마지막으로, 사용자 요청을 처리할 UserController 클래스를 정의합니다. 이 컨트롤러는 API 엔드포인트를 통해 사용자 정보를 조회, 추가, 수정, 삭제하는 역할을 합니다.
@RestController
@RequestMapping("/api/users")
public class UserController {
@Autowired
private UserService userService;
@GetMapping
public List<User> getAllUsers() {
return userService.findAllUsers();
}
@PostMapping
public User createUser(@RequestBody User user) {
return userService.saveUser(user);
}
@PutMapping("/{id}")
public User updateUser(@PathVariable Long id, @RequestBody User user) {
return userService.updateUser(id, user);
}
@DeleteMapping("/{id}")
public void deleteUser(@PathVariable Long id) {
userService.deleteUser(id);
}
}
이번 포스트에서는 스프링 부트를 사용하여 RESTful API를 구축하는 방법을 알아보고, 간단한 CRUD API 예제를 통해 사용자 데이터를 관리하는 과정을 살펴보았습니다. RESTful API는 현대적인 애플리케이션 개발에서 필수적인 요소로, 클라이언트와 서버 간에 데이터를 효율적으로 주고받을 수 있게 해줍니다.
특히 스프링 부트는 RESTful API를 쉽게 구현할 수 있는 다양한 기능을 제공하므로, 이를 잘 활용하면 확장성과 유지 보수성이 뛰어난 애플리케이션을 만들 수 있습니다. 이번 예제를 바탕으로 더 복잡한 API를 설계하고, 인증, 유효성 검사, 오류 처리와 같은 기능을 추가해 보세요.
RESTful API는 다양한 플랫폼에서 데이터를 주고받는 표준 방식이기 때문에, 이를 확실하게 이해하고 구현하는 것은 개발자로서 중요한 역량입니다.
다음 포스트에서 뵙겠습니다~!
