Task Manager API

Welcome to the Task Manager API documentation. This API allows users to manage tasks, including creating, retrieving, updating, and deleting tasks.

Table of Contents

• Introduction
• Endpoints
• Getting Started
• Usage
• Challenges Faced
• Future Improvements
• API Documentation

Introduction

The Task Manager API is designed to provide a straightforward way to manage tasks. It is built using the Express framework for handling HTTP requests and utilizes SQLite for the database.

Endpoints

• POST /api/: Create a new task.
• GET /api/: Get a list of all tasks.
• GET /api/:id: Get details of a specific task.
• DELETE /api/:id: Delete a task.
• PATCH /api/:id: Update the status of a task.

Getting Started

1. Clone this repository.
2. Install project dependencies using npm install.
3. Start the server with npm start.

Usage

• To create a new task, send a POST request to /api/ with the task details.
• To retrieve a list of all tasks, make a GET request to /api/.
• To get details of a specific task, send a GET request to /api/:id.
• To delete a task, use a DELETE request to /api/:id.
• To update a task's status, send a PATCH request to /api/:id.

Challenges Faced

While developing this API, I encountered challenges such as managing asynchronous operations, implementing error handling, and ensuring data validation. Utilizing async/await and creating a consistent error handling mechanism were key aspects. Also never to typescript had me searching and studing a lot about it and made me learn a lot.

Future Improvements

Given additional time, I would consider incorporating user authentication and authorization for enhanced task management. Additionally, I would have added more robust error handling including multiple errors.

API Documentation

For more detailed API documentation, you can refer to the following resources:

• Postman Collection Documenter