To test the server, you can query http://localhost:3000/api/health using Postman or just copy it in the address bar in your browser. If the server is running, you should receive "API is up and running" as response.

Get All Tasks

• Endpoint: /tasks/
• Method: GET
• Response:

[
  {
    "id": 1,
    "title": "Sample Task",
    "description": "This is a sample task",
    "duedate": "2019-08-24T14:15:22Z"
  }
  // ... other tasks
]

Create Task

• Endpoint: /api/tasks/
• Method: POST
• Request:

{
  "title": "New Task",
  "description": "A new task",
  "duedate": "2019-08-24T14:15:22Z"
}

• Response:

{
  "id": 5,
  "title": "New Task",
  "description": "A new task",
  "duedate": "2019-08-24T14:15:22Z"
}

Get Task by ID

• Endpoint: /api/tasks/{task_id}
• Method: GET
• Response:

{
  "id": 1,
  "title": "Sample Task",
  "description": "This is a sample task",
  "duedate": "2019-08-24T14:15:22Z"
}

Update Task

• Endpoint: /tasks/
• Method:
• Request:

{
  "title": "Updated Task",
  "description": "An updated task",
  "duedate": "2019-08-24T14:15:22Z"
}

• Response:

{
  "id": 1,
  "title": "Updated Task",
  "description": "An updated task",
  "duedate": "2019-08-24T14:15:22Z"
}

Delete Task

• Endpoint: /tasks/
• Method: DELETE

Testing API Endpoints using Swagger UI

Swagger UI provides an interactive interface for testing and exploring your API endpoints. Follow the steps below to use Swagger UI and test the endpoints of the Task Management API.

1. Access Swagger Documentation: Open your web browser and navigate to the Swagger UI documentation page. Typically, you can access Swagger UI by appending /docs to the base URL of your application. Replace http://localhost:3000 with your actual base URL.
2. Testing Endpoints

• Click on the endpoint you want to test. This will expand the endpoint - details and reveal the "Try it out" button.
• Click the "Try it out" button next to the endpoint you selected.
• If the endpoint requires any input parameters, provide the necessary values in the input fields provided.
• Click the "Execute" button to send the API request.
• You can do this for all available endpoints
• If you want to modify the input parameters for an endpoint, simply update the values in the "Parameters" section and click "Execute" again.

3. View Responses:

• Once you execute the request, Swagger UI will display the response from the API, including the status code, response headers, and response body.
• If the response includes a JSON body, you'll see it formatted for easy reading.

4. Errors and Troubleshooting:

• If the API request results in an error, Swagger UI will display the error details, including the status code and error message.
• Carefully review the error message to troubleshoot and make necessary

Testing API Endpoints Using Postman

Apart from using Swagger UI, you can also use Postman to test your Task Management App API endpoints. Here's how you can import the Swagger documentation into Postman for testing:

1. Import SwaggerJSON:

Open Postman and follow these steps:

• Navigate to File>Import
• Paste the swaggerdocs uri in the import field. By default the URL is:

http://localhost:3000/docs.json

• Click Import button

Unit & e2e testing with Jest

Two test suites were written. One for end-to-end testing and another for unit testing the controller functions. Please note the following before running the tests. Note:

• Please make sure the app is not running before runnign the tests.
• Please edit the file src/tests/e2e/e2e.test.ts Line 10 to select the ID of the test to be updated and deleted to avoid flakiness.

  const testTaskID = //ID here;

• Please make sure there are couple of items available on the database before running the tests suite.

Running both Test Suites Use the command below to run both the e2e and unit tests suites at once

npm run test

Running e2e Test Suite Use the command below to run the e2e test suite only.

npm run test:e2e

Running the unit test Suite Use the command below to run the unit test suite only.

npm run test:unit

Building and Testing the API with Docker Compose

Docker Compose is a tool that enables you to define and manage multi-container Docker applications. In your case, you already have Dockerfile configurations and a docker-compose.yml file to streamline the process.

1. Install Docker Compose: If you don't have Docker Compose installed, you can follow the installation instructions provided on the Docker Compose website.

2. Navigate to Project Directory: Open a terminal and navigate to the base directory containing the Dockerfile and docker-compose.yml.

3. Build and Start Containers: Run the following command to build and start the containers defined in the docker-compose.yml file:

   docker-compose up --build
   

4. Access the API:
   Once the containers are up and running, your API should be accessible through a web browser or API client at the specified port, which is likely the same as what's defined in your .env file.

5. Stopping the Containers: When you're finished testing, you can stop the containers gracefully by returning to the terminal and pressing Ctrl+C

6. Cleaning Up: To remove the containers and clean up resources, run the following command:

docker-compose down

• This command will stop and remove the containers, networks, and volumes defined in your docker-compose.yml file.