[스프링] HATEOAS를 사용한 RESTful API 설계

26 Dec 2023

스프링

HATEOAS란 무엇인가?
스프링에서 HATEOAS 사용하기
RESTful API에 HATEOAS 적용하기

1. HATEOAS란 무엇인가?

HATEOAS(하이퍼미디어 어플리케이션 상태)는 RESTful API의 핵심 원칙 중 하나로, API 응답에 클라이언트가 다음으로 수행할 수 있는 액션에 대한 링크 정보를 포함시키는 것을 말합니다. 이는 API의 상호 연결성을 향상시키고, 클라이언트와 서버 간의 결합도를 낮추어 유연한 API를 설계하는 데 도움을 줍니다.

2. 스프링에서 HATEOAS 사용하기

스프링 프레임워크에서는 spring-hateoas라는 모듈을 통해 HATEOAS를 구현할 수 있습니다. 이 모듈은 애플리케이션을 구성하고 하이퍼미디어 기반의 RESTful API를 쉽게 구축할 수 있도록 도와줍니다.

@Repository
public interface UserRepository extends JpaRepository<User, Long> {
}

@Service
public class UserService {
    @Autowired
    private UserRepository userRepository;

    public List<User> getAllUsers() {
        return userRepository.findAll();
    }
}

3. RESTful API에 HATEOAS 적용하기

RESTful API에서 HATEOAS를 적용하려면 스프링의 Resource 및 ControllerLinkBuilder 클래스를 사용하여 링크 정보를 포함한 응답을 구성해야 합니다.

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

    @GetMapping("/")
    public ResponseEntity<List<Resource<User>>> getAllUsers() {
        List<User> users = userService.getAllUsers();
        List<Resource<User>> userResources = new ArrayList<>();
        for (User user : users) {
            userResources.add(getUserResource(user));
        }

        return new ResponseEntity<>(userResources, HttpStatus.OK);
    }

    private Resource<User> getUserResource(User user) {
        Resource<User> userResource = new Resource<>(user);
        userResource.add(ControllerLinkBuilder.linkTo(methodOn(UserController.class).getAllUsers()).withRel("all-users"));
        // Add more links as needed
        return userResource;
    }
}

이제 클라이언트는 API 응답에서 포함된 링크 정보를 통해 다음으로 수행할 수 있는 액션에 대한 정보를 쉽게 얻을 수 있게 됩니다.

RESTful API를 설계할 때 HATEOAS를 적용하여 클라이언트와의 상호 작용을 간편하게 만들고, API의 유연성을 확보할 수 있습니다. 스프링 프레임워크의 spring-hateoas 모듈을 사용하면 HATEOAS를 쉽게 구현할 수 있으며, 이는 RESTful API의 설계 및 구축 과정을 보다 효율적으로 만들어줍니다.

참고문헌:

https://spring.io/projects/spring-hateoas