RESTful API to allow users to manage their to-do list

Desirable skills to acquire by doing this project:

• User authentication
• Schema design and Databases
• RESTful API design
• CRUD operations
• Error handling
• Security

Develop an API that satisfies the following requirements:

• User registration to create a new user
• Login endpoint to authenticate the user and generate a token
• CRUD operations for managing the to-do list
• Implement user authentication to allow only authorized user to access the to-do list
• Implement error handling and security measures
• Use a database to store the user and to-do list (PostgreSQL)
• Implement proper data validation
• Implement pagination and filtering for the to-do list
• Deploy the API inside a Docker container

Given below is a list of the endpoints and the details of the request and response:

User Registration

Register a new user using the following request:

POST /register
{
  "name": "John Doe",
  "email": "[email protected]"
  "password": "password"
}

This will validate the given details, ensure the email is unique, and store the user details in the database. The password will be hashed before being stored in the database. Respond with a token that can be used for authentication if the registration is successful.

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
}

The token will be a JWT token that can be used for authentication.

User Login

Authenticate the user using the following request:

POST /login
{
  "email": "[email protected]",
  "password": "password"
}

This will validate the given email and password, and respond with a token if the authentication is successful.

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
}

Create a To-Do Item

Create a new to-do item using the following request:

POST /todos
{
  "title": "Buy groceries",
  "description": "Buy milk, eggs, and bread"
}

User must send the token received from the login endpoint in the header to authenticate the request. You can use the Authorization header with the token as the value. In case the token is missing or invalid, respond with an error and status code 401.

{
  "message": "Unauthorized"
}

Upon successful creation of the to-do item, respond with the details of the created item.

{
  "id": 1,
  "title": "Buy groceries",
  "description": "Buy milk, eggs, and bread"
}

Update a To-Do Item

Update an existing to-do item using the following request:

PUT /todos/1
{
  "title": "Buy groceries",
  "description": "Buy milk, eggs, bread, and cheese"
}

Just like the create todo endpoint, user must send the token received. Also make sure to validate the user has the permission to update the to-do item i.e. the user is the creator of todo item that they are updating. Respond with an error and status code 403 if the user is not authorized to update the item.

{
  "message": "Forbidden"
}

Upon successful update of the to-do item, respond with the updated details of the item.

{
  "id": 1,
  "title": "Buy groceries",
  "description": "Buy milk, eggs, bread, and cheese"
}

Delete a To-Do Item

Delete an existing to-do item using the following request:

DELETE /todos/1

User must be authenticated and authorized to delete the to-do item. Upon successful deletion, respond with the status code 204.

Get To-Do Items

Get the list of to-do items using the following request:

GET /todos?page=1&limit=10

User must be authenticated to access the tasks and the response should be paginated. Respond with the list of to-do items along with the pagination details.

{
  "data": [
    {
      "id": 1,
      "title": "Buy groceries",
      "description": "Buy milk, eggs, bread"
    },
    {
      "id": 2,
      "title": "Pay bills",
      "description": "Pay electricity and water bills"
    }
  ],
  "page": 1,
  "limit": 10,
  "total": 2
}