Our search API is quite good, but let's do something more interesting. Like a lot of web applications, we will need a user management module to identify our users. For that, we will create a new user package. In this package, we will add a model class as follows:
package masterSpringMvc.user;
import java.time.LocalDate;
import java.util.ArrayList;
import java.util.List;
public class User {
private String twitterHandle;
private String email;
private LocalDate birthDate;
private List<String> tastes = new ArrayList<>();
// Getters and setters for all fields
}Since we do not want to use a database just yet, we will create a UserRepository class in the same package, backed by a simple Map:
package masterSpringMvc.user;
import org.springframework.stereotype.Repository;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
@Repository
public class UserRepository {
private final Map<String, User> userMap = new ConcurrentHashMap<>();
public User save(String email, User user) {
user.setEmail(email);
return userMap.put(email, user);
}
public User save(User user) {
return save(user.getEmail(), user);
}
public User findOne(String email) {
return userMap.get(email);
}
public List<User> findAll() {
return new ArrayList<>(userMap.values());
}
public void delete(String email) {
userMap.remove(email);
}
public boolean exists(String email) {
return userMap.containsKey(email);
}
}Finally, in the user.api package, we will create a very naive controller implementation:
package masterSpringMvc.user.api;
import masterSpringMvc.user.User;
import masterSpringMvc.user.UserRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.List;
@RestController
@RequestMapping("/api")
public class UserApiController {
private UserRepository userRepository;
@Autowired
public UserApiController(UserRepository userRepository) {
this.userRepository = userRepository;
}
@RequestMapping(value = "/users", method = RequestMethod.GET)
public List<User> findAll() {
return userRepository.findAll();
}
@RequestMapping(value = "/users", method = RequestMethod.POST)
public User createUser(@RequestBody User user) {
return userRepository.save(user);
}
@RequestMapping(value = "/user/{email}", method = RequestMethod.PUT)
public User updateUser(@PathVariable String email, @RequestBody User user) {
return userRepository.save(email, user);
}
@RequestMapping(value = "/user/{email}", method = RequestMethod.DELETE)
public void deleteUser(@PathVariable String email) {
userRepository.delete(email);
}
}We implemented all the classic CRUD operations with a RESTful repository by using the user's e-mail address as a unique identifier.
In this scenario, you will quickly face problems as Spring strips contents found after a dot. The solution is very similar to what we use to support semicolons in URLs in the URL mapping with matrix variables section in Chapter 4, File Upload and Error Handling.
Add the useRegisteredSuffixPatternMatch property that is set to false in the configurePathMatch() method that we have already defined in the WebConfiguration class:
@Override
public void configurePathMatch(PathMatchConfigurer configurer) {
UrlPathHelper urlPathHelper = new UrlPathHelper();
urlPathHelper.setRemoveSemicolonContent(false);
configurer.setUrlPathHelper(urlPathHelper);
configurer.setUseRegisteredSuffixPatternMatch(true);
}Now that we've got our API, we can start interacting with it.
Here are a few sample commands with httpie:
~ $ http get http://localhost:8080/api/users HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Date: Mon, 20 Apr 2015 00:01:08 GMT Server: Apache-Coyote/1.1 Transfer-Encoding: chunked [] ~ $ http post http://localhost:8080/api/users [email protected] birthDate=2011-12-12 tastes:='["spring"]' HTTP/1.1 200 OK Content-Length: 0 Date: Mon, 20 Apr 2015 00:02:07 GMT Server: Apache-Coyote/1.1 ~ $ http get http://localhost:8080/api/users HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Date: Mon, 20 Apr 2015 00:02:13 GMT Server: Apache-Coyote/1.1 Transfer-Encoding: chunked [ { "birthDate": "2011-12-12", "email": "[email protected]", "tastes": [ "spring" ], "twitterHandle": null } ] ~ $ http delete http://localhost:8080/api/user/[email protected] HTTP/1.1 200 OK Content-Length: 0 Date: Mon, 20 Apr 2015 00:02:42 GMT Server: Apache-Coyote/1.1 ~ $ http get http://localhost:8080/api/users HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Date: Mon, 20 Apr 2015 00:02:46 GMT Server: Apache-Coyote/1.1 Transfer-Encoding: chunked []
This is good but not great. Status codes are not yet handled. We will need more RESTfulness to climb up the Richardson ladder.