[스프링] HATEOAS와 클라이언트 측의 자동화된 상호작용

26 Dec 2023

스프링

스프링 HATEOAS를 사용하면 API의 하이퍼미디어 링크를 포함하는 데스크립터를 만들어 클라이언트의 동적 디스커버리와 자동화 된 상호작용을 지원할 수 있습니다. 이것은 클라이언트가 링크 정보를 통해 리소스에 접근하고 조작할 수 있게 해줍니다.

이 기술의 주요 이점 중 하나는 클라이언트 응용 프로그램의 변화에 민첩하게 대응할 수 있다는 것입니다. 즉, 서버 측의 리소스 변경이 클라이언트 측의 변경을 요구하지 않으므로 유연한 애플리케이션 설계를 할 수 있으며 API 버전 관리를 간소화할 수 있습니다.

이러한 이점을 이해하고 애플리케이션에 적용하는 방법을 살펴보겠습니다. 스프링 HATEOAS를 사용한 RESTful API 예제를 보여줄 것이며, 클라이언트 측에서 자동화 된 상호작용을 구현하는 방법을 소개할 것입니다.

HATEOAS란 무엇인가?

HATEOAS는 RESTful한 시스템 디자인의 일부로, 하이퍼미디어 링크를 활용하여 클라이언트가 리소스와 상호작용할 수 있는 방법을 제공하는 개념입니다.

스프링 HATEOAS 설정

스프링 프레임워크에서 HATEOAS를 사용하려면, 의존성을 추가하고 Link, EntityModel, CollectionModel 등의 클래스들을 사용하여 응답 본문에 하이퍼미디어 링크를 포함해야 합니다.

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-hateoas'
}

HATEOAS를 활용한 RESTful API 구현

간단한 RESTful API를 스프링 부트와 HATEOAS를 사용하여 구현할 수 있습니다. 이 때, EntityModel과 Link 클래스를 사용하여 리소스에 대한 하이퍼미디어 링크를 제공할 수 있습니다.

@RestController
public class BookController {
    
    @GetMapping("/books/{id}")
    public EntityModel<Book> getBook(@PathVariable Long id) {
        Book book = // 책 정보 조회 로직
        Link selfLink = linkTo(methodOn(BookController.class).getBook(id)).withSelfRel();
        return EntityModel.of(book, selfLink);
    }
}

클라이언트 측의 자동화된 상호작용

클라이언트 측에서는 받은 응답의 하이퍼미디어 링크 정보를 분석하고, 다음 동작을 자동으로 결정할 수 있습니다.

ResponseEntity<EntityModel<Book>> response = // API 호출
EntityModel<Book> bookResource = response.getBody();
Link selfLink = bookResource.getRequiredLink(IanaLinkRelations.SELF);
URI uri = selfLink.toUri();
// URI를 이용한 추가 동작 수행

이렇게 하면 클라이언트가 받은 응답의 링크 정보를 활용하여 추가적인 상호작용을 자동으로 수행할 수 있게 됩니다.

이제 클라이언트 측에서 자동화 된 상호작용을 구현하는 방법을 알아보았습니다.

HATEOAS를 활용하면 서버와 클라이언트 간의 상호작용을 향상시키고, API의 변경에 더 유연하게 대응할 수 있습니다. 스프링 프레임워크와 HATEOAS를 결합하여 이러한 원칙을 쉽게 적용할 수 있으며, 클라이언트 측에서도 이러한 상호작용을 자동화할 수 있습니다. 이를 통해 보다 유연하고 효율적으로 RESTful API를 구현할 수 있게 됩니다.

목차

HATEOAS란 무엇인가?

스프링 HATEOAS 설정

HATEOAS를 활용한 RESTful API 구현

클라이언트 측의 자동화된 상호작용