API

Java로 REST API 구현하기

지오준 2024. 9. 21.
반응형

소개

REST API는 웹 애플리케이션에서 데이터를 주고받기 위한 표준화된 방법입니다. Java에서는 Spring Boot를 사용하여 쉽게 REST API를 구현할 수 있습니다. 이번 포스트에서는 간단한 예제와 함께 REST API를 구현하는 방법을 단계별로 설명하겠습니다.

프로젝트 설정

먼저, Spring Boot 프로젝트를 생성합니다. Spring Initializr를 사용하면 쉽게 설정할 수 있습니다.

  1. Spring Initializr에 접속합니다.
  2. Project: Maven Project
  3. Language: Java
  4. Spring Boot: 2.5.4
  5. Project Metadata를 입력합니다.
  6. Dependencies: Spring Web을 추가합니다.
  7. Generate 버튼을 눌러 프로젝트를 다운로드합니다.

다운로드한 프로젝트를 IDE에서 열어줍니다.

기본 구조

프로젝트의 기본 구조는 다음과 같습니다:

src
└── main
    ├── java
    │   └── com.example.demo
    │       ├── DemoApplication.java
    │       ├── controller
    │       │   └── UserController.java
    │       ├── model
    │       │   └── User.java
    │       └── service
    │           └── UserService.java
    └── resources
        └── application.properties

모델 클래스 생성

먼저, User 모델 클래스를 생성합니다.

Java
 
package com.example.demo.model;

public class User {
    private Long id;
    private String name;
    private String email;

    // Getters and Setters
}
AI で生成されたコード。ご確認のうえ、慎重にご使用ください。FAQ で詳細を確認

서비스 클래스 생성

다음으로, UserService 클래스를 생성합니다.

Java
 
package com.example.demo.service;

import com.example.demo.model.User;
import org.springframework.stereotype.Service;

import java.util.ArrayList;
import java.util.List;

@Service
public class UserService {
    private List<User> users = new ArrayList<>();

    public List<User> getAllUsers() {
        return users;
    }

    public void addUser(User user) {
        users.add(user);
    }
}
AI で生成されたコード。ご確認のうえ、慎重にご使用ください。FAQ で詳細を確認

컨트롤러 클래스 생성

마지막으로, UserController 클래스를 생성합니다.

Java
 
package com.example.demo.controller;

import com.example.demo.model.User;
import com.example.demo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/api/users")
public class UserController {
    @Autowired
    private UserService userService;

    @GetMapping
    public List<User> getAllUsers() {
        return userService.getAllUsers();
    }

    @PostMapping
    public void addUser(@RequestBody User user) {
        userService.addUser(user);
    }
}
AI で生成されたコード。ご確認のうえ、慎重にご使用ください。FAQ で詳細を確認

애플리케이션 실행

모든 설정이 완료되었으니 애플리케이션을 실행해봅시다. DemoApplication.java 파일을 실행하면 Spring Boot 애플리케이션이 시작됩니다.

Java
 
package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}
AI で生成されたコード。ご確認のうえ、慎重にご使用ください。FAQ で詳細を確認

테스트

애플리케이션이 실행되면, Postman과 같은 도구를 사용하여 API를 테스트할 수 있습니다.

  • GET 요청: http://localhost:8080/api/users
  • POST 요청: http://localhost:8080/api/users
    JSON
     
    {
        "id": 1,
        "name": "John Doe",
        "email": "john.doe@example.com"
    }
    
    AI で生成されたコード。ご確認のうえ、慎重にご使用ください。FAQ で詳細を確認

결론

이렇게 해서 Java와 Spring Boot를 사용하여 간단한 REST API를 구현해보았습니다. 이 예제를 바탕으로 더 복잡한 기능을 추가해보세요!

반응형

댓글