<module>uri-customization</module>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

<modelVersion>4.0.0</modelVersion>

<artifactId>spring-data-rest-uri-customizations</artifactId>

<name>Spring Data REST - URI Customizations Example</name>

<parent>

<groupId>org.springframework.data.examples</groupId>

<artifactId>spring-data-rest-examples</artifactId>

<version>1.0.0.BUILD-SNAPSHOT</version>

</parent>

<properties>

<spring-data-releasetrain.version>Hopper-BUILD-SNAPSHOT</spring-data-releasetrain.version>

</properties>

<dependencies>

<dependency>

<groupId>org.springframework.data</groupId>

<artifactId>spring-data-keyvalue</artifactId>

</dependency>

<dependency>

<groupId>com.jayway.jsonpath</groupId>

<artifactId>json-path</artifactId>

<scope>test</scope>

</dependency>

</dependencies>

</project>

This example shows how to customize which property of the domain type shall be used to create URIs for item resources. This is achieved by implementing an `EntityLookup` and declaring it as Spring bean:

As you can see the customization consists of two methods that need to be symmetric in their functionality. `getResourceIdentifier(…)` returns the property that's supposed to be used in the URI while `lookupEntity(…)` uses the value to lookup an entity via a query method for exactly that property.

package example.springdata.rest.uris;

import javax.annotation.PostConstruct;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

import org.springframework.data.map.repository.config.EnableMapRepositories;

public class Application {

public static void main(String[] args) {

SpringApplication.run(Application.class, args);

}

@Autowired UserRepository repository;

@PostConstruct

public void init() {

repository.save(new User("olivergierke"));

repository.save(new User("starbucksman"));

}

}

package example.springdata.rest.uris;

import lombok.Value;

import java.util.UUID;

import org.springframework.data.annotation.Id;

public class User {

private final @Id UUID id = UUID.randomUUID();

private final String username;

}

package example.springdata.rest.uris;

import lombok.NonNull;

import lombok.RequiredArgsConstructor;

import java.io.Serializable;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.data.rest.core.support.EntityLookup;

import org.springframework.data.rest.core.support.EntityLookupSupport;

import org.springframework.stereotype.Component;

@RequiredArgsConstructor(onConstructor = @__(@Autowired) )

public class UserEntityLookup extends EntityLookupSupport<User> {

private final @NonNull UserRepository repository;

/*

@Override

public Serializable getResourceIdentifier(User entity) {

return entity.getUsername();

}

/*

@Override

public Object lookupEntity(Serializable id) {

return repository.findByUsername(id.toString());

}

}

package example.springdata.rest.uris;

import java.util.Optional;

import java.util.UUID;

import org.springframework.data.repository.CrudRepository;

public interface UserRepository extends CrudRepository<User, UUID> {

/**

Optional<User> findByUsername(String username);

}

package example.springdata.rest.uris;

import static org.hamcrest.CoreMatchers.*;

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;

import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;

import org.junit.Before;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.boot.test.SpringApplicationConfiguration;

import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

import org.springframework.test.context.web.WebAppConfiguration;

import org.springframework.test.web.servlet.MockMvc;

import org.springframework.test.web.servlet.setup.MockMvcBuilders;

import org.springframework.web.context.WebApplicationContext;

@RunWith(SpringJUnit4ClassRunner.class)

@SpringApplicationConfiguration(classes = Application.class)

public class WebIntegrationTests {

@Autowired WebApplicationContext context;

@Autowired UserRepository users;

MockMvc mvc;

@Before

public void setUp() {

this.mvc = MockMvcBuilders.webAppContextSetup(context).//

build();

}

@Test

public void identifiesResourcesUsingUsername() throws Exception {

mvc.perform(get("/users/olivergierke")).//

andExpect(status().isOk()).//

andExpect(jsonPath("$._links.self.href", endsWith("olivergierke")));

}

}

org.springframework.restdocs.outputDir=target/generated-snippets