spring rest api 응용

22 Sep 2023

springboot

Spring은 Java 웹 애플리케이션 개발을 위한 인기 있는 프레임워크 중 하나입니다. Spring에서 RESTful 웹 서비스를 개발하는 것은 간단하고 강력한 방법입니다. 이번 포스트에서는 Spring을 사용하여 REST API를 개발하는 방법을 알아보겠습니다.

1. Spring Boot 프로젝트 생성

Spring Boot를 사용하여 REST API를 개발하기 위해 먼저 Spring Boot 프로젝트를 생성해야 합니다. 이를 위해 다음과 같은 단계를 따릅니다.

Spring Initializr (https://start.spring.io/)을 방문합니다.
프로젝트 메타데이터를 입력하고 필요한 종속성을 선택합니다. REST API 개발을 위해 Spring Web 종속성을 선택해야 합니다.
프로젝트를 생성하고 압축된 파일을 내려받습니다.
압축을 풀고 IDE에 프로젝트를 import합니다.

2. REST API 엔드포인트 구현

REST API를 개발하기 위해 먼저 엔드포인트를 구현해야 합니다. 이를 위해 다음과 같은 단계를 따릅니다.

새로운 Java 클래스를 생성하고 @RestController 어노테이션을 추가합니다.
엔드포인트를 정의하기 위해 @RequestMapping 어노테이션을 사용합니다. 예를 들어, @RequestMapping("/api/products")는 ‘/api/products’ 경로에 대한 요청을 처리하는 메소드를 정의합니다.
각 메소드는 HTTP 요청 메소드에 따라 @GetMapping, @PostMapping, @PutMapping, @DeleteMapping 등의 어노테이션을 사용하여 지정됩니다.
메소드는 필요한 비즈니스 로직을 수행하고 결과를 반환합니다.

@RestController
@RequestMapping("/api/products")
public class ProductController {

    @GetMapping("/{id}")
    public ResponseEntity<Product> getProductById(@PathVariable Long id) {
        // ID를 사용하여 데이터베이스에서 제품을 가져오는 비즈니스 로직 수행
        Product product = productService.getProductById(id);
        return ResponseEntity.ok(product);
    }

    @PostMapping
    public ResponseEntity<Product> createProduct(@RequestBody Product product) {
        // 새로운 제품을 데이터베이스에 추가하는 비즈니스 로직 수행
        Product createdProduct = productService.createProduct(product);
        return ResponseEntity.created(URI.create("/api/products/" + createdProduct.getId())).body(createdProduct);
    }

    @PutMapping("/{id}")
    public ResponseEntity<Product> updateProduct(@PathVariable Long id, @RequestBody Product product) {
        // ID를 사용하여 기존 제품을 업데이트하는 비즈니스 로직 수행
        Product updatedProduct = productService.updateProduct(id, product);
        return ResponseEntity.ok(updatedProduct);
    }

    @DeleteMapping("/{id}")
    public ResponseEntity<Void> deleteProduct(@PathVariable Long id) {
        // ID를 사용하여 제품을 삭제하는 비즈니스 로직 수행
        productService.deleteProduct(id);
        return ResponseEntity.noContent().build();
    }
}

위의 예제에서는 ProductController라는 REST API 컨트롤러를 정의하였습니다. 각 메소드는 @GetMapping, @PostMapping, @PutMapping, @DeleteMapping 어노테이션을 사용하여 HTTP 요청 메소드에 매핑됩니다.

3. 테스트

REST API를 개발했다면 실제로 테스트해 보는 것이 중요합니다. 이를 위해 다음과 같은 방법을 사용할 수 있습니다.

Postman 또는 cURL과 같은 API 개발 도구를 사용하여 REST API에 직접 요청을 보냅니다.
JUnit과 MockMvc를 사용하여 통합 테스트를 작성합니다.

마치며

Spring을 사용하여 REST API를 개발하는 것은 간단하고 효율적입니다. 위의 단계를 따라가면서 Spring을 활용한 REST API 개발에 대한 기본적인 이해를 얻을 수 있을 것입니다. 추후 포스트에서는 Spring Security와의 통합, 데이터 유효성 검사 및 예외 처리 등의 고급 주제에 대해 다루도록 하겠습니다.

#spring #restapi