Updating A Book Listing By ID - Planning
Last updated
Last updated
Refer back to section for the API endpoint specifications.
Note that updating a book is quite similar to creating a book, so most of the planning here in this section will be quite similar to the last one.
Referring back to the sections under chapter 3, and , we can continue to build upon our books namespace.
We'll use PUT as our method verb of choice since we are updating a resource, and we'll also put the :id as one of the URI parameters.
PUT /api/v1/books/:id
Since updating a book will have the same fields as creating one, these are the fields that will be input to us by the user.
title
description
price
author
datePublished
There are two layers of middleware that we will add here.
The first reusing our isAuthenticated helper that will protect us from unauthenticated user from accessing this endpoint.
The second will be a backend service validation check where we'll be checking if the currently authenticated user who is requesting to update said book is fact the owner of that book.
There is also one more thing I would like to add into this middleware, which is a check on whether or not the client's request book ID exists. You'll see how this will be done in implementation section of this endpoint.
You might be wondering why we didn't put this logic somewhere in our domain layer. Well, we could if we wanted to, there wouldn't have been anything wrong with it. Remember that middleware is flexible and can be used in many different ways.
Same as creating a book, we will need to perform the following validation rules for each of these fields.
title - required.
description - required.
price - required, numeric, minimum number is 1.
author - required.
datePublished- required, valid date format.
We'll built on top of the previous section and use the bookModel.
We'll also need some sort of way to make a query to the database in order to find the existing book and update it, so we'll use the bookRepository layer and add the method updateById() to do so.
bookRepository
updateById()
On top of that, our controller will call a service to updateBookById(), in this case, it will be the bookService which will use the bookRepository layer.
bookService
updateBookById()
None.
Again, very similar to the previous section, except there will be 4 possible responses that can be output with this endpoint.
The first is the authentication middleware that we'll be reusing.
The second has to deal with whether or not the client has put in the correct fields to pass the form validation.
The third is whether or not the client has inputted an existing book ID.
The fourth is the successful scenario. Do keep in mind that since we are using a PUT request, we'll be returning the entire representation back, meaning that the update response should have the exact same fields as the create response.