HOME

In this tutorial, we will generate a Newman HTML Report.

Table of Contents

1. What is Newman HTML Report?
2. Prerequisite
3. Implementation Steps
   1. Install newman-reporter-htmlextra package
   2. Export the already created Postman tests
   3. Run the API collection through command line
   4. View Newman HTML Report
   5. Additional CLI Options

What is Newman HTML Report?

A Newman HTML reporter that has been extended to include the separation of the iteration runs so these are no longer aggregated together and also some additional handlebars helpers to enable users to create better custom templates

This reporter comes with a dashboard-style summary landing page and a set of different tabs that contain detailed request information. There are also a few optional configuration flags available, to tailor the final report in a number of different ways.

Prerequisite:

1. NodeJS is installed
2. Newman is installed

Implementation Steps

Step 1: Install newman-reporter-htmlextra package

Go to cmd prompt and type the below command:-

npm install -g newman-reporter-htmlextra

Step 2: Export the already created Postman tests

Export your Postman API collection as JSON file. To know how to export Collection in Postman, please refer to this tutorial –  How to Export Postman Collections?.

This screen provides the option to export the JSON file as Collection v2 or Collection v2.1 and click on the “Export” button.

Open the Command Line and go to that location of the collection JSON file.

Step 3: Run the API collection through the command line

Use the below command to execute the tests and generate an HTML Report. The following command will create a new report in the ./newman directory, if the directory does not exist, it will be created as part of the Newman run.

newman run API_Newman_Tests.json -r htmlextra

Go inside the newman folder and see a .html report is present.

Step 4: View Newman HTML Report

Double-click on the .html report and this will display. On the summary page, we get a summary of the test results we have run. We get detailed information like a number of iterations, assertions, skipped tests, and failed tests. From the Total Requests tab, we can get a lot of information like baseurl, the request body, the response header, and the response format. For more details, we can go to the Failed tests tab to check which scripts failed, the status code, and the assertion error message.

Go to the Total Requests tab to get all the information regarding the request method used, request URL, request body, response body, time taken to process the request, the means size of the request, and so on.

Go to the Failed Tests tab and see all the details about the failed tests.

Step 5: Additional CLI Options

Specify a path for the HTML Report.

Specify a path where the output HTML file will be written to disk.

Use the below command.

newman run API_Newman_Tests.json -r htmlextra --reporter-htmlextra-export ./results/report.html

If the path is not specified, the file will be written to the newmain/ in the current working directory.

That’s it! Congratulations on making it through this tutorial and hope you found it useful! Happy Learning!!