https://github.com/gadiim/dogapipostmannewmanghactions

The Pet API Testing Project aims to provide automated API service testing using Newman and GitHub Actions.
https://github.com/gadiim/dogapipostmannewmanghactions

api-testing automation newman-reporter pet-api postman

Last synced: 29 days ago
JSON representation

The Pet API Testing Project aims to provide automated API service testing using Newman and GitHub Actions.

• Host: GitHub
• URL: https://github.com/gadiim/dogapipostmannewmanghactions
• Owner: gadiim
• License: mit
• Created: 2024-11-09T22:00:13.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-12-10T18:30:57.000Z (about 1 month ago)
• Last Synced: 2024-12-10T19:44:25.676Z (about 1 month ago)
• Topics: api-testing, automation, newman-reporter, pet-api, postman
• Language: HTML
• Homepage: https://gadiim.github.io/DogAPIPostmanNewmanGhActions/
• Size: 140 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![CI](https://github.com/gadiim/DogAPIPostmanNewmanGhActions/actions/workflows/ci.yml/badge.svg)

## Pet API Test

**Objective:**  

The objective of the Pet API Testing Project is to automate the testing of API services for pet-related data, ensuring they function correctly and reliably. The project leverages Postman collections run by Newman and integrates with GitHub Actions for continuous integration and deployment (CI/CD).

**Tools:**  

- Newman

- Postman

- GitHub Action

- Node.js

**Project Structure:**

```sql

dogapipostmannewmanghactions/

├── .github

│   └── workflows

│       └── ci.yml                     # GitHub Actions workflow configuration

├── newman

│   └── newman-run-report.html         # HTML test reports generated by Newman

├── package.json                       # npm scripts and dependencies configuration

├── PetAPI.postman_collection.json     # Postman collection for API testing

└── README.md                          # Project description and details

```

**Scripts:** 

`npm run`

- `test`: Runs tests using Newman and generates an HTML report.

- `test:report`: Runs tests and generates an HTML report with detailed results.

**Reporting:**

Newman is used for generating detailed test reports, providing insights into test results, and making it easier to understand the test execution and outcomes.



**License:**

This project is licensed under the MIT License. You are free to use, modify, and distribute this project. See the [LICENSE](./LICENSE.txt) file for more details.