REST API fundamentals review in Postman - Framework Patterns

Framework Mode - REST API fundamentals review

Folder Structure

rest-api-testing-project/
├── collections/
│   └── api-tests.postman_collection.json
├── environments/
│   ├── dev.postman_environment.json
│   ├── staging.postman_environment.json
│   └── prod.postman_environment.json
├── scripts/
│   ├── pre-request-scripts.js
│   └── test-scripts.js
├── reports/
│   └── test-report.html
├── README.md
└── postman.config.json

Test Framework Layers

• Collections: Group of REST API requests organized by feature or endpoint.
• Environments: Variables for different deployment stages like dev, staging, prod.
• Pre-request Scripts: JavaScript code run before requests to set variables or headers.
• Test Scripts: JavaScript assertions run after responses to validate API behavior.
• Reports: Generated test execution summaries for review.
• Configuration: Settings for Postman CLI or Newman to run tests automatically.

Configuration Patterns

• Environment Variables: Store base URLs, tokens, and credentials per environment to switch easily.
• Global Variables: Shared values across collections for common data.
• Collection Variables: Scoped to a collection for specific test data.
• Secure Credentials: Use environment variables or external vaults, avoid hardcoding secrets.
• Postman Configuration File: Define default environment and collection for automated runs.

Test Reporting and CI/CD Integration

• Newman CLI: Run Postman collections from command line with detailed reports.
• HTML Reports: Generate readable reports showing passed/failed tests and response times.
• CI/CD Pipelines: Integrate Newman runs in Jenkins, GitHub Actions, GitLab CI for automated testing on code changes.
• Notifications: Configure alerts on test failures via email or chat tools.

Best Practices

• Use Descriptive Names: Name requests and tests clearly for easy understanding.
• Modularize Tests: Group related API calls in collections and use folders for organization.
• Use Variables: Avoid hardcoding URLs and credentials; use environment and collection variables.
• Validate Responses: Check status codes, response body structure, and data correctness.
• Automate Runs: Use Newman and CI/CD to run tests regularly and catch regressions early.

Self Check

Where in this folder structure would you add a new environment configuration for a testing environment?

Key Result

Organize REST API tests in Postman collections with environment variables and automate runs using Newman for reliable validation.