How to expose the resourceId with Spring Data Rest

Question

I had was to expose the primary key which is annotated with @Id in entity.the ID field is only visible on the resource path, but not on the JSON body.

Hiatt

Possible duplicate of Spring boot @ResponseBody doesn't serialize entity id – Ingemar

Answer 1

You can configure this using the RepositoryRestConfigurerAdapter on entity level.

@Configuration
public class ExposeEntityIdRestConfiguration extends RepositoryRestConfigurerAdapter {

    @Override
    public void configureRepositoryRestConfiguration(RepositoryRestConfiguration config) {
        config.exposeIdsFor(MyEntity.class);
    }
}

Be aware that using this you are working against the principles of spring-data-rest - sdr promotes hypermedia to be able to use an API by navigating between resources using links - here your resources are identified and referenced by links and thus the ids are not needed anymore. Using ids on your client pushes the complexity of constructing links to resources to the client. And the client should not be bothered with this knowledge.

Banger

Is there a way to expose id's of all your entities at once? For e.g. setting in config? – Christan

How can I do it for all the entities at once? We have many package this module doesn't know about. – Afterclap

RepositoryRestConfigurerAdapter is now deprecated (since 3.1). Implement RepositoryRestConfigurer instead by overriding the same method. – Melone

Answer 2

The best solution would be not to using the IDs of your entities, and use the link references the hypermedia provides. You just need to parse your JSON accordingly to the HAL specification used by Spring Data Rest.

Abramabramo