[spring boot] HATEOAS 간단하게 사용해보기

HATEOAS 란?

Hypermedia As The Engine Of Application State 의 약자이다.

rest API에서,

서버는 현재 리소스와 연관된 링크 정보를 클라이언트에게 제공한다.

클라이언트는 연관된 링크 정보를 바탕으로 리소스에 접근한다.

연관된 링크 정보: Relation Hypertext Reference;

 

 HATEOAS 간단하게 사용해보기

spring-boot-starter-hateoas 의존성 추가

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-hateoas</artifactId>
</dependency>

Entity 작성

@Getter
@Setter
@noargsconstructor
public class Hello {
    private String prefix;
    private String name;
}

Controller 에서 link 연결

@RestController
public class SampleController {

    @GetMapping("/hello")
    public EntityModel<Hello> hello(){
        Hello hello = new Hello();
        hello.setPrefix("Hey,");
        hello.setName("jueun");

        EntityModel<Hello> helloEntity;
        helloEntity = EntityModel.of(hello,
                linkTo(methodOn(SampleController.class).hello()).withSelfRel());
        return helloEntity;
    }
}

 

제일 간단하게 호출된 self의 링크를 연결해보았다.

출력 결과

Test 해보기

@RunWith(SpringRunner.class)
@WebMvcTest(SampleController.class)
public class SampleControllerTest {

    @Autowired
    MockMvc mockMvc;
    
    // @Autowired
    // ObjectMapper objectMapper;

    @Test
    public void hello() throws Exception {
        mockMvc.perform(get("/hello"))
                .andDo(print())
                .andExpect(status().isOk())
                .andExpect(jsonPath("$._links.self").exists());
    }
}

추가로, hateoas가 아닌 web만 추가하더라도 제공해주는 ObjectMapper 그냥 주입해서 쓸 수 있다.

객체를 json으로 변환하거나 json을 객체로 변환할 때 사용하는 맵퍼클래스이다.

커스터마이징은 설정파일에서 spring.jackson.* 이하의 옵션들을 통해 할 수 있다.

 

마지막으로 덧붙여서, HATEOAS는 LinkDiscovers 제공한다.

클라이언트 쪽에서 링크 정보를 Rel 이름으로 찾을 때 사용할 수 있는 XPath 확장 클래스라고 한다.

---

Building a Hypermedia-Driven RESTful Web Service (공식문서) #

HATEOAS 레퍼런스 #