Disable Hypertext Application Language (HAL) in JSON?

by

(Hyper)media types

The default settings for Spring Data REST use HAL as the default hypermedia representation format, so the server will return the following for the given Accept headers:

  • No header -> application/hal+json -> HAL
  • application/hal+json -> application/hal+json -> HAL
  • application/json -> application/json -> HAL (this is what the default configures)
  • application/x-spring-data-verbose+json -> application/x-spring-data-verbose+json -> a Spring Data specific format (using links for the links container and content as wrapper for the collection items.

If you configure RepositoryRestConfiguration.setDefaultMediaType(…) to a non-HAL format, the server will return the Spring Data specific JSON format unless you explicitly ask for application/hal+json. Admittedly the configuration option is probably a bit misleading, so I filed DATAREST-294 to improve this. The issue was resolved in 2.1 RC1 (Dijkstra) 2014.

Note that we effectively need a hypermedia format in place to be able to express relations between managed resources and enable discoverability of the server. So there’s no way you’ll be able to get rid of it completely. This is mostly due to the fact that you could easily crash the server if you expose entities that have bidirectional relationships or make up an enormous object graph.

Inlining related entities

If you never want to have sectors linked to and always inline them, one option is to simply exclude the SectorRepository from being exported as a REST resource in the first place. You can achieve this by annotating the repository interface with @RepositoryRestResource(exported = false).

To get a representation returned as you posted in your lower example have a look at the projections feature introduced in Spring Data REST 2.1 M1. It basically allow you to craft optional views on a resource that can differ from the default one via a simple interface.

You’d basically define an interface:

@Projection(name = "foo", types = YourDomainClass.class)
interface Inlined {

  // list all other properties

  Sector getSector();
}

If you either put this interface into a (sub)package of your domain class or manually register it via RepositoryRestConfiguration.projectionConfiguration() the resources exposing YourDomainClass will accept a request parameter projection so that passing in foo in this example would render the inlined representation as you want it.

This commit has more info on the feature in general, this commit has an example projection defined.

More Related Contents:

  1. Why does RestTemplate not bind response representation to PagedResources?
  2. JSON parse error: Can not construct instance of java.time.LocalDate: no String-argument constructor/factory method to deserialize from String value
  3. JsonMappingException: could not initialize proxy – no Session
  4. Create REST API without using any backend
  5. How do I POST JSON data with cURL?
  6. What is “406-Not Acceptable Response” in HTTP?
  7. Posting a File and Associated Data to a RESTful WebService preferably as JSON
  8. Use of PUT vs PATCH methods in REST API real life scenarios
  9. How to use Spring managed Hibernate interceptors in Spring Boot?
  10. How to maintain bi-directional relationships with Spring Data REST and JPA?
  11. How do I send a JSON string in a POST request in Go
  12. Can Spring Data REST’s QueryDSL integration be used to perform more complex queries?
  13. How to consume Page response using Spring RestTemplate
  14. Filtering data with Spring boot CrudRepository
  15. What is the difference between resource and resource representation in REST?
  16. Curl GET request with json parameter
  17. REST with Spring and Jackson full data binding
  18. Post a json body with swagger
  19. Spring REST service: retrieving JSON from Request
  20. Unable to find a MessageBodyReader of content-type application/json and type class java.lang.String
  21. JSON, REST, SOAP, WSDL, and SOA: How do they all link together
  22. Modify default JSON error response from Spring Boot Rest Controller
  23. With Spring Data REST, why is the @Version property becoming an ETag and not included in the representation?
  24. REST API Best practices: args in query string vs in request body
  25. How do I decode HTML entities in Swift?
  26. How do I modify fields inside the new PostgreSQL JSON datatype?
  27. Spring data jpa- No bean named ‘entityManagerFactory’ is defined; Injection of autowired dependencies failed
  28. Convert MongoDB BsonDocument to valid JSON in C#
  29. alamofire.error Code=-6006 “JSON could not be serialized
  30. Spring Data JPA – Is it possible to sort on a calculated property?

Leave a Comment