Check out the full series of Questions Management tutorial here.
In the previous tutorial, we prepared all the necessary configurations to build API update option such as an Option document object containing the information of an option, an OptionRepository for manipulation with MongoDB, an OptionController defines APIs for Core Option Service starting with “/option” and the connection information to the MongoDB server is configured in the application.properties file. Now, let’s build this API!
To build API update option, I would add a method in the OptionController class to expose a PUT request “/option/{id}” with id as id of the option that we need to update.
|
1 2 3 4 5 6 |
@PutMapping("/{id}") public Mono<ResponseEntity<Option>> updateOption( @PathVariable(value = "id") String optionId, @RequestBody Option option) { } |
The steps to update an option include:
First, we need to check that the option we need to update does exist or not based on the id that the user is passing on.
Spring Data MongoDB Reactive has provided us with a way to search by id so we just need to call it.
|
1 |
optionRepository.findById(optionId) |
In case this option exists, we will use the information passed in the body data to update the information in the database:
|
1 2 3 4 5 6 7 8 |
optionRepository.findById(optionId) .flatMap(existingOption -> { existingOption.setNote(option.getNote()); existingOption.setIsCorrect(option.getIsCorrect()); existingOption.setDescription(option.getDescription()); return optionRepository.save(existingOption); }) |
Then returning to the user new information of this option after having updated the database with the HTTP status code of 200 OK.
|
1 2 3 4 5 6 7 8 9 |
optionRepository.findById(optionId) .flatMap(existingOption -> { existingOption.setNote(option.getNote()); existingOption.setIsCorrect(option.getIsCorrect()); existingOption.setDescription(option.getDescription()); return optionRepository.save(existingOption); }) .map(updatedOption -> new ResponseEntity<>(updatedOption, HttpStatus.OK)) |
In case this option does not exist in the database, we will return the result of the HTTP status code is 404 Not Found.
|
1 2 3 4 5 6 7 8 9 10 |
optionRepository.findById(optionId) .flatMap(existingOption -> { existingOption.setNote(option.getNote()); existingOption.setIsCorrect(option.getIsCorrect()); existingOption.setDescription(option.getDescription()); return optionRepository.save(existingOption); }) .map(updatedOption -> new ResponseEntity<>(updatedOption, HttpStatus.OK)) .defaultIfEmpty(new ResponseEntity<>(HttpStatus.NOT_FOUND)); |
The entire contents of the updateOption() method will now look like this:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
@PutMapping("/{id}") public Mono<ResponseEntity<Option>> updateOption( @PathVariable(value = "id") String optionId, @RequestBody Option option) { return optionRepository.findById(optionId) .flatMap(existingOption -> { existingOption.setNote(option.getNote()); existingOption.setIsCorrect(option.getIsCorrect()); existingOption.setDescription(option.getDescription()); return optionRepository.save(existingOption); }) .map(updatedOption -> new ResponseEntity<>(updatedOption, HttpStatus.OK)) .defaultIfEmpty(new ResponseEntity<>(HttpStatus.NOT_FOUND)); } |
At this point we have finished building the API to update an option for the Core Option Service.
Currently I have the following options:
the when I request to update option with id is 5b871766f62c5604f6a6a8fb, the result will be:
