Check out the full series of Questions Management tutorial here.
In the previous tutorial, we prepared all the necessary configurations to be able to build API deletion option such as an Option document object containing the information of an option, an OptionRepository to manipulate MongoDB, an OptionController defines APIs for Core Option Service will start with “/option” and the connection information to the MongoDB server is configured in the application.properties file. Now, we are going to build this API!
To build API deletion option, I would add a method in the OptionController class to expose a DELETE request “{id}” with id as the id of the option that we need to delete:
|
1 2 3 4 |
@DeleteMapping("/{id}") public Mono<ResponseEntity<Void>> deleteOption(@PathVariable(value = "id") String optionId) { } |
The steps to delete an option include:
First, we need to check that the option we want to delete does exist or not based on the id that the user 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 delete it and return the HTTP status code to 200 OK.
|
1 2 3 |
optionRepository.findById(optionId) .flatMap(existingOption -> optionRepository.delete(existingOption) .then(Mono.just(new ResponseEntity<Void>(HttpStatus.OK)))) |
If it does not exist, return the HTTP status code of 404 Not Found.
|
1 2 3 4 |
return optionRepository.findById(optionId) .flatMap(existingOption -> optionRepository.delete(existingOption) .then(Mono.just(new ResponseEntity<Void>(HttpStatus.OK)))) .defaultIfEmpty(new ResponseEntity<>(HttpStatus.NOT_FOUND)); |
The entire contents of the deleteOption() method will now look like this:
|
1 2 3 4 5 6 7 |
@DeleteMapping("/{id}") public Mono<ResponseEntity<Void>> deleteOption(@PathVariable(value = "id") String optionId) { return optionRepository.findById(optionId) .flatMap(existingOption -> optionRepository.delete(existingOption) .then(Mono.just(new ResponseEntity<Void>(HttpStatus.OK)))) .defaultIfEmpty(new ResponseEntity<>(HttpStatus.NOT_FOUND)); } |
At this point, we have completed the API delete option for Core Option Service, let’s test it out!
Suppose I currently have the following options:
then when you request to delete option with id is 5ae874c345286708520dd0e5, the result will be:
