Add an API to Delete a Note
Finally, we are going to create an API that allows a user to delete a given note.
Add the Function
Create a new file in src/delete.js
and paste the following.
import handler from "./util/handler";
import dynamoDb from "./util/dynamodb";
export const main = handler(async (event) => {
const params = {
TableName: process.env.TABLE_NAME,
// 'Key' defines the partition key and sort key of the item to be removed
Key: {
userId: "123", // The id of the author
noteId: event.pathParameters.id, // The id of the note from the path
},
};
await dynamoDb.delete(params);
return { status: true };
});
This makes a DynamoDB delete
call with the userId
& noteId
key to delete the note. We are still hard coding the userId
for now.
Add the Route
Let’s add a new route for the delete note API.
Add the following below the PUT /notes{id}
route in lib/ApiStack.js
.
"DELETE /notes/{id}": "src/delete.main",
Deploy Our Changes
If you switch over to your terminal, you’ll notice that you are being prompted to redeploy your changes. Go ahead and hit ENTER.
Note that, you’ll need to have sst start
running for this to happen. If you had previously stopped it, then running npx sst start
will deploy your changes again.
You should see that the API stack is being updated.
Stack dev-notes-api
Status: deployed
Outputs:
ApiEndpoint: https://5bv7x0iuga.execute-api.us-east-1.amazonaws.com
Test the API
Let’s test the delete note API.
Run the following in your terminal.
Make sure to keep your local environment (sst start
) running in another window.
$ curl -X DELETE https://5bv7x0iuga.execute-api.us-east-1.amazonaws.com/notes/NOTE_ID
Make sure to replace the id at the end of the URL with the noteId
from when we created our note.
Here we are making a DELETE request to the note that we want to delete. The response should look something like this.
{"status":true}
Commit the Changes
Let’s commit and push our changes to GitHub.
$ git add .
$ git commit -m "Adding the API"
$ git push
So our API is publicly available, this means that anybody can access it and create notes. And it’s always connecting to the 123
user id. Let’s fix these next by handling users and authentication.
For help and discussion
Comments on this chapter