Task Management REST API
\nThis project involves creating a Task Management REST API using Go and the Gin Framework. The API is designed to manage tasks through basic CRUD (Create, Read, Update, Delete) operations, leveraging MongoDB for persistent data storage. Docker is utilized to containerize the application, ensuring consistent environments across development, testing, and production.
\nThe API includes endpoints to retrieve all tasks, view details of a specific task, update a task's details, delete a task, and create new tasks. It ensures proper error handling, response codes, and adheres to Go best practices. MongoDB is used for efficient data storage and retrieval, and Docker provides a reliable setup for running the application in various environments.
\nDocumentation is provided for all endpoints, detailing request payloads and response formats. The API is tested using Postman to verify functionality and ensure compliance with specifications, demonstrating a robust and scalable approach to task management.
\nTo test the Task Management API, follow these steps:
\nThis endpoint allows the client to register a new user.
\nemail (string, required): The email of the user.password (string, required): The password for the user account.message (string): A message indicating the result of the registration.user (object):id (string): The unique identifier for the user.email (string): The email address of the user.role (string): The role of the user in the system.accessToken (string): Access token for the registered user.The request should include a JSON payload in the raw request body type with the following fields:
\nemail (string): The email of the user.password (string): The password of the user.Upon successful login, the response will have a status code of 200 and a Content-Type of application/json. The response body will include a JSON object with the following fields:
\nuser (object): An object containing the user details with the following fields:id (string): The user's ID.email (string): The user's email.role (string): The user's role.accessToken (string): The access token for the logged-in user.{\n \"user\": {\n \"id\": \"\",\n \"email\": \"\",\n \"role\": \"\"\n },\n \"accessToken\": \"\"\n}\n\nThis section handles authentication for the Task Management API. It includes user registration and login functionalities, utilizing JSON Web Tokens (JWT) to secure access to protected endpoints. Upon successful login, users receive a JWT, which must be included in the header of subsequent requests to access restricted routes.
\nTo enhance security, the JWT is configured to expire every 30 minutes. Users will need to authenticate again to obtain a new token once the current one expires. This approach ensures that the system regularly verifies user identity and reduces the risk of unauthorized access.
\n","_postman_id":"15423946-13d2-48cb-ae07-5545ac813193"},{"name":"Task manager","item":[{"name":"Retrive all tasks","event":[{"listen":"test","script":{"id":"88735c07-6de4-4c9a-acb6-abe005efeced","exec":["var template = `","","","| ID | ","Title | ","Description | ","Due Date | ","Status | ","
|---|---|---|---|---|
| {{id}} | ","{{title}} | ","{{description}} | ","{{due_date}} | ","{{status}} | ","
This endpoint retrieves a list of tasks.
\nThere are no request parameters for this endpoint.
\nThe response body will contain an array of tasks, where each task object includes the following properties:
\nExample response body:
\n[\n {\n \"id\": \"task1\",\n \"title\": \"Task 1\",\n \"description\": \"Complete task 1\",\n \"due_date\": \"2022-12-31\",\n \"status\": \"in_progress\"\n },\n {\n \"id\": \"task2\",\n \"title\": \"Task 2\",\n \"description\": \"Review task 2\",\n \"due_date\": \"2022-11-15\",\n \"status\": \"pending\"\n }\n]\n\nThis endpoint retrieves the details of a specific task identified by its ID.
\nNo request body is required for this endpoint.
\nThe response will be in JSON format and will contain the following fields:
\nid (string): The unique identifier of the task.title (string): The title or name of the task.description (string): A brief description of the task.due_date (string): The due date of the task.status (string): The current status of the task.{\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"due_date\": \"\",\n \"status\": \"\"\n}\n\nThis endpoint is used to create a new task.
\nid (text, required): The unique identifier for the task.
title (text, required): The title of the task.
description (text, optional): The description of the task.
due_date (text, optional): The due date of the task.
status (text, required): The status of the task.
The response is in JSON format with the following schema:
\n{\n \"id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"due_date\": \"\",\n \"status\": \"\"\n}\n\nThis endpoint allows updating a specific task identified by the ID in the URL. The request should include the task ID, title, description, due date, and status in the request body. The request body should be in JSON format.
\nid (string): The ID of the task.title (string): The title of the task.description (string): The description of the task.due_date (string): The due date of the task.status (string): The status of the task.The response will have a status code of 200 and a JSON body representing the updated task. The JSON schema for the response body is as follows:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\" },\n \"title\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"due_date\": { \"type\": \"string\" },\n \"status\": { \"type\": \"string\" }\n }\n}\n\nThis endpoint sends an HTTP DELETE request to delete a specific task identified by the provided task ID.
\nThis request does not require a request body.
\nThe response will indicate the success or failure of the deletion operation.
\n","urlObject":{"protocol":"http","port":"8081","path":["tasks","66b450c5e72e34cb6e8acc32"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"756484fd-5a20-4131-9476-a2bd699dfa35","name":"forbidden","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InRlc3QyMEBnbWFpbC5jb20iLCJleHAiOiIyMDI0LTA4LTEwVDExOjIwOjE2LjMzNDE3NTErMDM6MDAiLCJyb2xlIjoidXNlciIsInVzZXJfaWQiOiI2NmI0YjU5ZmMxNTJmMWQwZTY4ZGNkZmQifQ.BvYPsh885mJtQTwJgy6EutXx5HHPi6yM-E1OnWEfOA0","type":"text"}],"url":"http://localhost:8081/tasks/66b450c5e72e34cb6e8acc32"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sat, 10 Aug 2024 07:53:33 GMT"},{"key":"Content-Length","value":"61"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Forbidden only admin user can perform this action\"\n}"},{"id":"764b4c7c-2949-4ca0-8212-6c908fa35c37","name":"unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InRlc3QyMEBnbWFpbC5jb20iLCJleHAiOiIyMDI0LTA4LTEwVDExOjIwOjE2LjMzNDE3NTErMDM6MDAiLCJyb2xlIjoidXNlciIsInVzZXJfaWQiOiI2NmI0YjU5ZmMxNTJmMWQwZTY4ZGNkZmQifQ.BvYPsh885mJtQTwJgy6EutXx5HHPi6yM-E1OnWEfOA0","type":"text","disabled":true}],"url":"http://localhost:8081/tasks/66b450c5e72e34cb6e8acc32"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sat, 10 Aug 2024 07:53:49 GMT"},{"key":"Content-Length","value":"24"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Unauthorized\"\n}"},{"id":"b7bd6656-54c3-4e8d-818b-2f6328a24681","name":"success","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InRlc3RAZ21haWwuY29tIiwiZXhwIjoiMjAyNC0wOC0xMFQxMToxNzoxNS40NDY2NDAwOTcrMDM6MDAiLCJyb2xlIjoiYWRtaW4iLCJ1c2VyX2lkIjoiNjZiNGI0ZDU1NzAxYjdhMTFkZjJmNzczIn0.x7J0f_B5_RrjnZSamvOUqF-3Q34rBTdZkcnATaLcFOc","type":"text"}],"url":"http://localhost:8081/tasks/66b450c5e72e34cb6e8acc32"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Sat, 10 Aug 2024 07:59:40 GMT"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"5325d47b-2290-47c2-ae97-16c948a9157d"}],"id":"ec8ecb4a-0135-4c4a-8d05-13644f71d849","description":"This section is dedicated to handling the task service for the Task Management API. It involves managing tasks through basic CRUD (Create, Read, Update, Delete) operations, with secure access controlled by JSON Web Tokens (JWT).
\nThe task service includes endpoints to:
\nCurrently, only admins have the authorization to create new tasks. This restriction is enforced through JWT-based authentication, which ensures that only users with admin privileges can access the task creation endpoint. Each request to these endpoints must include a valid JWT in the header. The JWT is issued upon successful user login and is configured to expire every 30 minutes, requiring users to re-authenticate to obtain a new token after expiration.
\n","_postman_id":"ec8ecb4a-0135-4c4a-8d05-13644f71d849"},{"name":"User","item":[{"name":"promote user","id":"4f472b20-9b82-45f2-b98d-83a692c1a187","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY2YjlhZDA0NDJkMGQyNGVhZmExZTc2YyIsImVtYWlsIjoidGVzdDE0MGdtYWlsLmNvbSIsInJvbGUiOiJ1c2VyIiwiZXhwIjoxNzIzNDQ2Mjg1fQ.d4vwi7X7js4on3Vrf13wknamoiHT129_Iw5bUq6i8JM","type":"text"}],"url":"http://localhost:8081/promote/66b8ceaa6f5548c43cecbfe6","description":"This endpoint allows you to send an HTTP PATCH request to promote a specific item identified by its ID. The request should include the item ID in the URL. The request body should contain the necessary data to update the item.
\nThe request body should contain the data to be updated for the item.
\nmessage: A string indicating the result of the promotion action.{\n \"message\": \"\"\n}\n\nThis folder contains routes for user releted routes.
\n","_postman_id":"4cfafa32-004b-4275-b9e3-de548d70169c"}]}