{"id":15013794,"url":"https://github.com/haite4/postman-newman-task","last_synced_at":"2026-01-27T02:33:57.313Z","repository":{"id":252102727,"uuid":"839430931","full_name":"haite4/postman-newman-task","owner":"haite4","description":"Postman API testing:  https://haite4.github.io/postman-newman-task/    ","archived":false,"fork":false,"pushed_at":"2024-08-15T11:12:50.000Z","size":185,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-04T16:44:47.376Z","etag":null,"topics":["github-pages","html-report","newman","newman-reporter","newman-reporter-htmlextra","postman","postman-collection"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/haite4.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-07T15:38:23.000Z","updated_at":"2024-08-15T11:12:37.000Z","dependencies_parsed_at":"2024-11-18T17:42:46.157Z","dependency_job_id":"a6a65232-a6e9-4ddd-bb12-7eb213875b19","html_url":"https://github.com/haite4/postman-newman-task","commit_stats":null,"previous_names":["haite4/postman-newman-practise","haite4/postman-newman-task"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/haite4/postman-newman-task","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haite4%2Fpostman-newman-task","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haite4%2Fpostman-newman-task/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haite4%2Fpostman-newman-task/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haite4%2Fpostman-newman-task/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/haite4","download_url":"https://codeload.github.com/haite4/postman-newman-task/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haite4%2Fpostman-newman-task/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28796977,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-27T01:07:07.743Z","status":"online","status_checked_at":"2026-01-27T02:00:07.755Z","response_time":168,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-pages","html-report","newman","newman-reporter","newman-reporter-htmlextra","postman","postman-collection"],"created_at":"2024-09-24T19:44:47.414Z","updated_at":"2026-01-27T02:33:57.287Z","avatar_url":"https://github.com/haite4.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Postman + newman + github actions \r\n\r\n## Introduction\r\nThis project focuses on testing a local server API using Postman and Newman. It is integrated with GitHub Actions to automate the execution of API tests, and the test results are published to GitHub Pages.\r\n\r\n## Steps to Install\r\n1. Install Nodejs:\r\n\r\n    [Nodejs](https://nodejs.org/en/download/package-manager)\r\n\r\n2. Clone the repository:\r\n    ```sh\r\n    git clone https://github.com/haite4/postman-newman-task\r\n    ```\r\n3. Navigate to the project directory:\r\n    ```sh \r\n    cd postman-newman-task\r\n    ```\r\n\r\n4. Install dependencies:\r\n    ```sh\r\n    npm install \r\n    ``` \r\n\r\n## Steps to Launch\r\n\r\n1. **Run the local server**:\r\n    ```sh\r\n    npm run tern-on-api\r\n    ```\r\n   \r\n   \r\n## Overview of API Endpoints\r\n\r\nThis section provides an overview of the available API endpoints for interacting with the local server. The server supports routes for managing `products`, `orders`, and `users`. The table below details the operations for the `products` resource, which are similarly available for `orders` and `users`.\r\n\r\n| VERB     |Route          | Input      | Output             |\r\n|----------|---------------|------------|--------------------|\r\n| GET      | /products     | *None*     | **Array**          |\r\n| GET      | /products/:id |  **e.g 3** | **Object**         |\r\n| POST     | /products     | **object** | **Created object** |\r\n| PUT      | /products     | **object** | **Updated object** |\r\n| DELETE   | /products/:id | **e.g 3**  | **Deleted object** |\r\n\r\n## Testing with Postman\r\n\r\n1. **Open Postman**: Launch the Postman application on your computer.\r\n\r\n2. **Import Collection**: Import the `store.collection.json` file into Postman. This file contains the API requests and tests.\r\n\r\n3. **Run Tests**:\r\n   - **Single Test**: To run a specific test, select the request from the collection and click \"Send\" to execute it.\r\n   - **All Tests**: \r\n     - Right-click on the collection name in the sidebar.\r\n     - Select \"Run Collection\" from the context menu.\r\n     - The Collection Runner will open. In the Runner, click the \"Run \u003ccollection name\u003e\" button to start executing all tests. \r\n\r\n## Running Tests Locally with Newman\r\n\r\nNewman is a command-line utility that enables you to run Postman collections directly from your terminal. Follow these steps to execute your tests locally and view the results:\r\n\r\n1. **Install Newman**:\r\n   - To add Newman as a local development tool, run the following command:\r\n     ```sh\r\n     npm install newman --save-dev\r\n     ```\r\n\r\n2. **Execute the Tests and Create a Report**:\r\n   - Run your Postman collection and generate a test report by executing:\r\n     ```sh\r\n     npm run test:api\r\n     ```\r\n\r\n3. **View the Report**:\r\n   - **For macOS Users**: Open the report file in your default web browser by using:\r\n     ```sh\r\n     open  testResults/index.html\r\n     ```\r\n   - **For Windows Users**: Launch the report file in your default web browser with:\r\n     ```sh\r\n     start testResults/index.html\r\n     ```\r\n\r\n    - **For Linux Users**: Open the report file in your default web browser with:\r\n     ```sh\r\n        xdg-open testResults/index.html\r\n     ```\r\n\r\n\r\n## GitHub Actions Integration\r\n\r\nWe have set up a GitHub Actions workflow to automatically run the `petstore.collection.json` Postman collection. The workflow executes the API tests and publishes the results to GitHub Pages. You can review the test results at the following link:\r\n\r\n[View Test Results](https://haite4.github.io/postman-newman-task/)\r\n\r\n### Summary\r\n- **GitHub Actions Workflow**: The workflow is configured to run the Postman collection and generate test reports.\r\n- **Result Publication**: Test results are automatically published to GitHub Pages, providing a convenient way to access and review the results online.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaite4%2Fpostman-newman-task","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhaite4%2Fpostman-newman-task","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaite4%2Fpostman-newman-task/lists"}