Saving responses in Postman - Framework Patterns

Framework Mode - Saving responses

Folder Structure of a Postman Test Project

  PostmanProject/
  ├── collections/
  │   └── MyAPICollection.postman_collection.json
  ├── environments/
  │   ├── dev.postman_environment.json
  │   ├── staging.postman_environment.json
  │   └── prod.postman_environment.json
  ├── tests/
  │   └── responseTests.js
  ├── scripts/
  │   └── saveResponse.js
  ├── reports/
  │   └── testResults.json
  └── README.md
  

Test Framework Layers in Postman

• Collections: Group of API requests organized by feature or endpoint.
• Environments: Variables for different setups like dev, staging, prod.
• Tests: Scripts written in JavaScript to validate API responses.
• Pre-request Scripts: Scripts that run before requests to set up data or headers.
• Utilities/Scripts: Reusable JavaScript code to save responses or process data.
• Reports: Output files or dashboards showing test results.

Configuration Patterns for Saving Responses

• Environment Variables: Use environment variables to store dynamic data like tokens or IDs.
• Scripts to Save Responses: Use test scripts to save parts of the response to variables for later use.
• File Export: Use Newman CLI with reporters to export test run results and saved responses to files.
• Collection Runner: Run collections with different environments to test multiple setups.

Test Reporting and CI/CD Integration

• Use Newman (Postman CLI) to run collections in CI/CD pipelines.
• Configure reporters like JSON, HTML, or JUnit to generate readable reports.
• Save response data as part of test logs for debugging and traceability.
• Integrate with tools like Jenkins, GitHub Actions, or GitLab CI to automate tests and report results.

Best Practices for Saving Responses in Postman Frameworks

• Always save only necessary parts of the response to environment or collection variables to keep tests clean.
• Use descriptive variable names to make scripts easy to understand.
• Keep test scripts simple and focused on one assertion or save action at a time.
• Use environment files to separate data from test logic for easy maintenance.
• Regularly export and back up collections and environments to avoid data loss.

Self Check Question

Where in this folder structure would you add a new script to save a specific API response field for reuse in later requests?

Key Result

Organize Postman tests with collections, environments, scripts, and use test scripts to save API responses for reuse.