Spring Boot로 Hello World REST API 만들기

Java와 Spring Boot를 처음 배우는 분들이 가장 먼저 접하는 예제가 바로 Hello World REST API입니다.

Spring Boot를 사용해 최소한의 설정만으로 간단한 REST API를 구현하는 과정을 단계별로 알려드리겠습니다.

 

1. 프로젝트 생성

Spring Initializr 사용

Spring Boot 프로젝트를 생성하기 위해 https://start.spring.io를 사용합니다. 다음과 같이 설정하세요.

• Project: Gradle 또는 Maven
• Language: Java
• Spring Boot: 3.x 이상
• Dependencies: Spring Web

프로젝트를 생성하고 IDE(IntelliJ 등)에서 열어주세요.

 

2. 기본 디렉터리 구조

src
 └─ main
     ├─ java
     │   └─ com.example.helloworld
     │       └─ HelloWorldController.java
     └─ resources
         └─ application.properties

클래스와 패키지 이름은 프로젝트에 맞게 조정하세요.

 

3. HelloWorldController 클래스 작성

다음은 REST 컨트롤러를 구현하는 가장 기본적인 예시입니다.

package com.example.helloworld;

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

@RestController
public class HelloWorldController {

    @GetMapping("/hello")
    public String hello() {
        return "Hello, World!";
    }
}

@RestController는 해당 클래스가 REST API 엔드포인트 역할을 한다는 것을 나타내며, @GetMapping("/hello")는 GET /hello 요청에 대해 문자열 "Hello, World!"를 반환합니다.

 

4. 애플리케이션 실행

생성된 메인 클래스를 실행하면 내장 톰캣 서버가 포트 8080에서 애플리케이션을 실행합니다. 브라우저나 API 클라이언트(Postman 등)에서 아래 URL에 접속해보세요.

http://localhost:8080/hello

결과: Hello, World!

 

5. 실무에서의 확장 포인트

• JSON 응답: Map이나 DTO를 사용하여 JSON 형식의 응답을 구성할 수 있습니다.
• Swagger 연동: API 문서를 자동 생성하고 테스트할 수 있는 도구입니다.
• 예외 처리: @ControllerAdvice를 사용한 전역 예외 처리로 안정적인 API 설계가 가능합니다.

 

6. 마무리

Hello World 예제는 단순하지만, RESTful API의 작동 방식을 이해하는 데 매우 유용합니다. Spring Boot의 강력한 자동 설정 덕분에 몇 줄의 코드만으로 API를 완성할 수 있다는 점에서 이 기술 스택의 강점을 실감할 수 있습니다.