The TODO API is a RESTful API that allows users to manage their to-do lists. It provides endpoints for user registration and login, visualization, creation, modification, and closure of TODO items.
The user information is stored in a MongoDB database and is encrypted with bcrypt. Tokens are used for authorization of access to the TODO features. The API uses the Joi library for validation of the request bodies, and the jsonwebtoken library for token creation and verification.
The API uses a middleware function to authenticate requests that require authentication. The middleware function extracts the JWT from the request headers and verifies it using a secret key stored in the environment variables. If the JWT is valid, the request is passed to the next middleware function or route handler. If the JWT is invalid, the function returns a 401 status code and an error message.
Authentication is required to use this API. Requests must include an access token in the Authorization header to access all routes except registration and login routes.
Creates a new user and saves it to the database.
email(required): An unique e-mail with minimum of 6 and maximum of 255 characters.password(required): String with minimum of 6 and maximum of 255 characters.
The endpoint returns a 201 status code with a message if the user is successfully registered.
The endpoint returns an error message if the email is invalid or if it has already been used, or if there was an error on the server.
{
"message": "User created successfully."
}Verifies user credentials and returns a JWT token for authorization.
email(required): An unique e-mail with minimum of 6 and maximum of 255 characters.password(required): String with minimum of 6 and maximum of 255 characters.
The endpoint returns a 200 status code, a message of request succeeded and the JSON Web Token (JWT) that can be used to authenticate further requests.
If any error occur, such as incorrect password or non-existent user, an error message will be returned.
{
"message": "You are successfully logged in.",
"token": "user_token"
}Creates a new TODO item.
description(required): Unique and not null string.deadline(required): Valid date in ISO format.statusconclusion(optional): Boolean.
The endpoint returns a 201 status code if the TODO item is successfully created, or an error message if the description is not unique, the deadline is not a valid date, or if there is a server error.
{
"message": "TODO created successfully."
}Modifies a not closed TODO item.
description(required): Unique and not null string, must match the one of an existing TODO item.newDescription(optional): Unique and not null string.newDeadline(optional): Boolean.
The endpoint updates the item's description and/or deadline fields and returns a 200 status code if the item is successfully updated.
The endpoint returns an error message if the TODO is not found, the TODO is closed, the new description and/or new deadline are not valid, or if there is a server error.
{
"message": "TODO created successfully."
}Closes a TODO item.
description(required): Unique and not null string, must match the one of an existing and open TODO item.
The endpoint updates the item's statusconclusion to true and returns a 200 status code if the item is successfully closed, or an error message if the item is not found, the item is already closed, or if there is a server error.
{
"message": "TODO item closed successfully."
}This route retrieves a list of all TODOs. No parameters are required. Authentication is achieved through the access token provided in the Authorization header of the requests.
{
"TODOs": [
{
"description": "Math homework",
"deadline": "2023-05-14T00:00:00.000Z",
"statusconclusion": false,
"isPastDeadline": false,
"lastmodification": "2023-05-08T02:49:32.263Z"
},
{
"description": "Clean the house",
"deadline": "2023-05-07T00:00:00.000Z",
"statusconclusion": true,
"isPastDeadline": true,
"lastmodification": "2023-05-08T02:49:53.586Z"
}
]
}