자바와 스프링 부트로 생애 최초 서버 만들기

#8 Spring Boot로 GET API 24.12.18

박태정 입니다. 2025. 2. 12. 16:20
반응형

Spring Boot로 GET API 개발하기 🌟

Spring Boot를 사용해 간단한 계산기를 만들어 보려고 합니다! 이번 포스팅에서는 GET API를 개발하는 과정을 코드와 함께 알아보겠습니다. 😊

1. GET API란 무엇인가요? 🔍

API(Application Programming Interface)는 애플리케이션 간의 통신을 도와주는 인터페이스입니다. 그중 GET API는 서버로부터 데이터를 가져오는 데 사용됩니다. 예를 들어, 계산기에서 두 숫자의 합을 요청할 때 사용됩니다.

2. 코드 살펴보기 🛠️

아래는 Spring Boot로 두 숫자를 더하는 간단한 GET API를 구현한 코드입니다.

package org.zerock.libraryapp.controller.calculator;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class CalculatorController {

    @GetMapping("/add") // GET /add
    public int addTwoNumbers(@RequestParam int number1, @RequestParam int number2) {
        return number1 + number2;
    }
}

3. 코드 설명 📖

(1) @RestController

  • Rest API를 처리하는 컨트롤러임을 나타냅니다.
  • 반환 값이 JSON 또는 HTTP 응답 형태로 변환됩니다.

(2) @GetMapping("/add")

  • HTTP Method가 GET이고, 경로가 /add인 API를 설정합니다.
  • 사용자가 /add?number1=10&number2=20 같은 URL로 요청하면 처리됩니다.

(3) @RequestParam

  • 쿼리 파라미터를 함수의 매개변수로 바인딩합니다.
  • number1, number2 값을 요청 URL에서 추출하여 사용합니다.

4. API 테스트하기 🧪

Spring Boot 애플리케이션을 실행한 후, Postman과 같은 도구를 사용해 API를 테스트할 수 있습니다.

  1. Postman 실행
  2. HTTP Method를 GET으로 설정
  3. URL에 http://localhost:8080/add?number1=10&number2=20 입력
  4. 결과로 30이 반환되는지 확인

5. DTO의 필요성 📦

위 코드에서는 두 개의 숫자만 받기 때문에 간단한 구조로 작성했습니다. 하지만 여러 파라미터를 입력받을 경우, 코드는 점점 복잡해질 수 있습니다. 이를 해결하기 위해 DTO(Data Transfer Object)를 사용할 수 있습니다.

DTO란?

  • 데이터를 전송하기 위한 객체입니다.
  • 여러 파라미터를 하나의 객체로 묶어 처리할 수 있습니다.

마무리: 핵심 정리 ✅

  • @RestController: 컨트롤러 클래스에서 REST API를 처리할 때 사용합니다.
  • @GetMapping: GET 요청을 처리하며, 특정 경로를 지정합니다.
  • @RequestParam: URL의 쿼리 파라미터를 함수 매개변수로 바인딩합니다.
  • DTO를 활용하면 복잡한 데이터를 깔끔하게 처리할 수 있습니다.
반응형