Colin's Blog
[java] Spring Framework를 이용한 RESTful API 개발 방법

Spring Framework는 Java 기반의 웹 애플리케이션을 개발하기 위해 널리 사용되고 있는 프레임워크입니다. 이러한 Spring Framework를 이용하여 RESTful API를 개발하는 방법을 알아봅시다.

1. 프로젝트 설정과 의존성 추가

Spring Boot를 이용하여 RESTful API를 개발하려면, 먼저 프로젝트를 설정하고 필요한 의존성을 추가해야 합니다. Maven이나 Gradle과 같은 빌드 도구를 사용하여 아래와 같이 의존성을 추가합니다.

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>

2. 컨트롤러 생성

RESTful API를 개발하기 위해 먼저 컨트롤러를 생성해야 합니다. 컨트롤러는 클라이언트의 요청을 받아 처리하고, 결과를 반환하는 역할을 담당합니다.

@RestController
public class UserController {

    @GetMapping("/users")
    public List<User> getAllUsers() {
        // 사용자 목록을 조회하는 로직
        // ...
        return userList;
    }
    
    @PostMapping("/users")
    public User createUser(@RequestBody User user) {
        // 사용자 생성 로직
        // ...
        return user;
    }
    
    // 다른 CRUD 메서드들을 추가로 구현할 수 있습니다.
}

3. 데이터 모델 생성

RESTful API에서는 클라이언트와 서버 간에 데이터를 주고받습니다. 따라서 데이터 모델을 정의해야 합니다. 예를 들어, 사용자 정보를 담고 있는 User 클래스를 만들 수 있습니다.

public class User {
    private String name;
    private int age;
    
    // getter, setter 메서드 등을 추가합니다.
}

4. 서비스 로직 구현

API를 호출하는 클라이언트의 요청을 처리하기 위해 필요한 비즈니스 로직을 구현합니다. 이 예제에서는 UserService 클래스를 만들어 사용자 관련 로직을 구현합니다.

@Service
public class UserService {
    
    public List<User> getAllUsers() {
        // 사용자 목록을 조회하는 비즈니스 로직
        // ...
        return userList;
    }
    
    public User createUser(User user) {
        // 사용자 생성 로직
        // ...
        return user;
    }
    
    // 다른 비즈니스 로직 메서드들을 추가로 구현할 수 있습니다.
}

5. 애플리케이션 실행

Spring Boot는 내장된 Tomcat 서버를 통해 애플리케이션을 실행할 수 있습니다. 이를 위해 메인 애플리케이션 클래스에 @SpringBootApplication 어노테이션을 추가하고, SpringApplication.run() 메서드를 호출합니다.

@SpringBootApplication
public class MyApplication {

    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

6. API 호출 및 결과 확인

Spring Boot가 실행되면, 정의한 API를 호출하여 결과를 확인할 수 있습니다. 예를 들어, localhost:8080/users로 GET 요청을 보내면 사용자 목록을 받아볼 수 있습니다.

결론

Spring Framework를 이용하여 RESTful API를 개발하는 방법을 알아보았습니다. 이를 통해 간단한 API를 구현하고 실행하여 결과를 확인할 수 있습니다. Spring Framework는 유연하고 강력한 기능을 제공하므로, 실제 프로젝트에서 RESTful API를 개발할 때 많은 도움이 될 것입니다.

© 2018 Colin. All rights reserved.