Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sokraglav13/api-testing-with-postman
https://github.com/sokraglav13/api-testing-with-postman
Last synced: 1 day ago
JSON representation
- Host: GitHub
- URL: https://github.com/sokraglav13/api-testing-with-postman
- Owner: sokraglav13
- Created: 2024-05-13T13:52:57.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-09-11T14:14:58.000Z (2 months ago)
- Last Synced: 2024-10-17T11:58:39.350Z (29 days ago)
- Language: JavaScript
- Size: 32.2 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API-Testing-with-Postman [](https://github.com/godpower13/API-Testing-with-Postman/actions?query=workflow%3ACI)
Welcome to the API Testing Project! This repository contains a comprehensive suite of automated API tests designed to ensure the robustness and reliability of our application endpoints. We leverage Postman's powerful capabilities for creating and managing our test collections. To automate the execution of these tests, we utilize Newman, Postman's command-line tool, which allows us to integrate API testing seamlessly into our CI/CD pipeline. Our test results are meticulously reported using the Allure Reporter, providing clear and actionable insights into the API performance and behavior. The workflow is designed to run these tests automatically on every push and pull request to the main branch, ensuring continuous quality assurance. Detailed test reports are generated and archived as artifacts, making it easy to review and track test outcomes over time. This setup not only streamlines our testing process but also ensures that our APIs remain reliable and performant.
# Capabilities
This project provides a robust and automated API testing framework using Postman and Newman, seamlessly integrated into a CI/CD pipeline with GitHub Actions. It ensures continuous testing and validation of API endpoints on every code change. Detailed test results are generated and reported using the Allure Reporter, offering clear insights into API performance and reliability. The automated workflow helps maintain high-quality APIs by catching issues early and providing actionable feedback, thus enhancing the overall development process.
# Tools
- Postman: Is a collaboration platform for testing and developing APIs (Application Programming Interfaces)
- Newman: Is a command-line Collection Runner for Postman. It enables you to run and test a Postman Collection directly from the command line.
- Allure Reporter: Is an open-source framework designed to create test execution reports.
# Run Tests Locally
- `npm run test` : Run tests cases and generates report files.
- `npm run generate-report` : Starts local server to provide the test results.
# Final Results
