While using Spring Data Rest after migrating an app to Spring Boot, I have observed that entity properties with @Id are no longer marshalled to JSON

Question

This question is related to this SO question (Spring boot @ResponseBody doesn't serialize entity id). I have observed that after migrating an app to Spring Boot and using the spring-boot-starter-data-rest dependency, my entity @Id fields are no longer marshalled in the resulting JSON.

This is my request mapping and while debugging, I can see the data isn't being changed prior to returning it, so the @Id properties are being stripped later on.

@RequestMapping(method = RequestMethod.GET, produces = {"application/json"})
public PagedResources<Receipt> receipts(Pageable pageable, PagedResourcesAssembler assembler) {
    Page<Receipt> receipts = receiptRepository.findByStorerAndCreatedDateGreaterThanEqual("003845", createdStartDate, pageable);
    PagedResources<Receipt> pagedResources = assembler.toResource(receipts, receiptResourceAssembler);
    return pagedResources;
}

Is there a setting that would allow me to keep the @Id field in the resulting JSON because my app allows the user to search by that value.

Thanks :)

Take a look at [this](https://stackoverflow.com/a/49344988/4071001) in case you need to expose the identifiers for all entities, or only for those that extends or implements specific super class or interface. — lcnicolau, Jun 27 '18 at 23:48

score 26 · Accepted Answer · edited Dec 05 '14 at 10:00

26

By default Spring Data Rest does not spit out IDs. However you can selectively enable it through exposeIdsFor(..) method. You could do this in configuration, something like this

@Configuration
public static class RepositoryConfig extends
        RepositoryRestMvcConfiguration {

    @Override
    protected void configureRepositoryRestConfiguration(
            RepositoryRestConfiguration config) {
        config.exposeIdsFor(Class1.class, Class2.class);
    }
}

edited Dec 05 '14 at 10:00

bluish

26,356
27
122
180

answered Jul 24 '14 at 15:54

Stackee007

3,196
1
26
39

4

It should be noted that if you are using spring-boot, you need to extend `SpringBootRepositoryRestMvcConfiguration` instead of `RepositoryRestMvcConfiguration` and make it a normal class not a static class. – jax Mar 02 '15 at 02:58
9

Since version 2.4, `configureRepositoryRestConfiguration` method should be overriden by extending `RepositoryRestConfigurerAdapter` class instead. – Can Bayburt Dec 01 '15 at 09:25
2

And don't forget to support now getter and setter for the id field in the entity class!.. (I forgot it and was searching much time for that) – phil Apr 21 '16 at 18:11
4

Is there in SpringBoot 1.3.* any setting that allows to expose all the id's at once by default? Or do I have to list them manually in RepositoryConfig class? ;/ – thorinkor Jul 21 '16 at 11:58

score 21 · Answer 2 · answered Sep 29 '15 at 18:38

As of Spring Data Rest 2.4 (which is a transitive dependency if using spring-boot 1.3.0.M5) you may use the RepositoryRestConfigurerAdapter. For instance,

@Configuration
class SpringDataRestConfig {

    @Bean
    public RepositoryRestConfigurer repositoryRestConfigurer() {

        return new RepositoryRestConfigurerAdapter() {
            @Override
            public void configureRepositoryRestConfiguration(
                                 RepositoryRestConfiguration config) {
                config.exposeIdsFor(Class1.class, Class2.class);
            }
        }

    }

}

For recent spring versions, this is the correct answer (except for the missing semi-colon). — Guido Flohr, May 30 '18 at 12:09

Grigory Kislin · Answer 3 · 2018-08-07T19:50:26.400

9

Before expose Id please read disussion: https://github.com/spring-projects/spring-hateoas/issues/66

In REST the id of a resource is its URI. The client doesn't explicitly use the id to build an url. You could, for example, replace your id for an uuid, for example. Or even change the url scheme.

edited Aug 07 '18 at 19:50

answered Nov 16 '15 at 21:14

Grigory Kislin

16,647
10
125
197

score 2 · Answer 4 · answered Feb 04 '18 at 19:38

2

put @getter, @setters and it will be exposed to json results, hope it would help you

answered Feb 04 '18 at 19:38

leon_

74
3

score 0 · Answer 5 · answered Sep 06 '17 at 04:27

@Id annotation in your model class does the magic.

public class Location {

    @Id
    private String woeid;
    private String locationName;

Then your mongo object will look like this:

{
    "_id" : "2487889",
    "_class" : "com.agilisys.weatherdashboard.Location",
    "locationName" : "San Diego, CA"
}

While using Spring Data Rest after migrating an app to Spring Boot, I have observed that entity properties with @Id are no longer marshalled to JSON

5 Answers5

Linked