spring-hateoas – Tarik Billa

How to remove the “_embedded” property in Spring HATEOAS

December 27, 2023 by Tarik

I close HAL feature, because it is hard to using Resources/Resource by restTemplate. I disable this feature by following code: public class SpringRestConfiguration implements RepositoryRestConfigurer { @Override public void configureRepositoryRestConfiguration(RepositoryRestConfiguration config) { config.setDefaultMediaType(MediaType.APPLICATION_JSON); config.useHalAsDefaultJsonMediaType(false); } } It work for me. HAL is good if there are more support with restTemplate.

Date format in the json output using spring boot

August 19, 2023 by Tarik

If you have Jackson integeration with your application to serialize your bean to JSON format, then you can use Jackson anotation @JsonFormat to format your date to specified format. In your case if you need your date into yyyy-MM-dd format you need to specify @JsonFormat above your field on which you want to apply this … Read more

Why HATEOAS starts creating issue for spring-boot version >= 2.2.x during startup with Swagger 2.x?

July 28, 2023 by Tarik

I had this issue with Swagger + HATEOAS in my spring-boot application. The fix is given below (edit your Swagger configuration class): @Configuration @EnableSwagger2 public class SwaggerConfiguration { @Bean public LinkDiscoverers discoverers() { List<LinkDiscoverer> plugins = new ArrayList<>(); plugins.add(new CollectionJsonLinkDiscoverer()); return new LinkDiscoverers(SimplePluginRegistry.create(plugins)); } }

Meaning and usage of “_embedded” in HATEOAS

June 9, 2023 by Tarik

There’s neither a REST nor a HATEOAS specification. Both are only concepts, or architectural styles, if you will. _embedded is part of the HAL format. It’s intended to embed (sic!) resources where otherwise only their URIs would be returned. For example GET http://localhost:8080/mywebservice/features is supposed to only return a list of URIs, like http://localhost:8080/mywebservice/features/GROUND, and … Read more

How to correctly use PagedResourcesAssembler from Spring Data?

June 2, 2023 by Tarik

You seem to have already found out about the proper way to use but I’d like to go into some of the details here a bit for others to find as well. I went into similar detail about PagedResourceAssembler in this answer. Representation models Spring HATEOAS ships with a variety of base classes for representation … Read more

Spring HATEOAS versus Spring Data Rest

May 26, 2023 by Tarik

Spring HATEOAS provides common abstractions (representational models, a Link class, API to build links pointing to Spring MVC controllers, etc.) to ease building hypermedia driven REST APIs with Spring MVC in general. Thus, you can use it alongside Spring MVC to manually build those services. Spring Data REST uses Spring HATEOAS to automatically expose resources … Read more

Spring HATEOAS embedded resource support

April 19, 2023 by Tarik

Make sure to read Spring’s documentation about HATEOAS, it helps to get the basics. In this answer a core developer points out the concept of Resource, Resources and PagedResources, something essential which is is not covered by the documentation. It took me some time to understand how it works, so let’s step through some examples … Read more

Using spring HATEOAS with spring webflux Functional Web Framework (reactor-netty)

March 21, 2023 by Tarik

By definition, you’re creating a custom route and Spring HATEOAS is an opinionated set of frameworks meant so you don’t have to lift a finger. What you are trying to do, and what Spring HATEOAS is doing are contradictory. So, you will have to manually create the payload if you want embedded hyperlinks. Although, this … Read more

When to use @RestController vs @RepositoryRestResource

January 15, 2023 by Tarik

Ok, so the short story is that you want to use the @RepositoryRestResource since this creates a HATEOAS service with Spring JPA. As you can see here adding this annotation and linking it to your Pojo you have a fully functional HATEOAS service without having to implement the repository method or the REST service methods … Read more