[RESTFUL 학습] HAETAOS

Hypermedia As The Engine Of Application state

Client에 링크로 사용 가능한 URL을 리소스로 전달하여, Client가 해당 리크를 참고할 수 있도록 하는 REST-API 기술

주로 마이크로서비스를 기반으로 프로젝트를 개발할 때 쓰인다고한다.

참조문서:https://spring.io/guides/gs/rest-hateoas/

 

아래와 같이 pom.xml에 hateoas dependency를 추가해야 hateoas를 사용할 수 있다.

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

 

	@GetMapping("/users/{id}")
	public EntityModel<User> retrieveUser(@PathVariable int id) {
		User user =service.findOne(id);
		if (user == null) {
			throw new UserNotFoundException(String.format("ID[%s] not found", id));
		}

		//HATEOAS
		EntityModel<User> model = new EntityModel<>(user);
		WebMvcLinkBuilder linkTo = linkTo(methodOn(this.getClass()).retrieveAllUsers());
		model.add(linkTo.withRel("all-users"));
		return model;
	}

위와 같이 return 할 EntityModel에 linkBuilder를 추가하여 리턴합니다.

methodOn에는 Link로 보낼 메서드를 추가합니다.  (아래 스크린샷의 메서드)

 

 

결과 :