Creating collections in Postman - Framework Setup Guide

Framework Mode - Creating collections

Folder Structure for Postman Collections

postman-project/
├── collections/
│   ├── UserManagement.postman_collection.json
│   ├── ProductAPI.postman_collection.json
│   └── AuthAPI.postman_collection.json
├── environments/
│   ├── dev.postman_environment.json
│   ├── staging.postman_environment.json
│   └── prod.postman_environment.json
├── scripts/
│   ├── pre-request-scripts.js
│   └── test-scripts.js
├── README.md
└── postman.config.json
  

Test Framework Layers in Postman Collections

• Collections Layer: Group of API requests organized by feature or service (e.g., User Management).
• Environment Layer: Variables for different environments like dev, staging, and production.
• Scripts Layer: JavaScript code for pre-request setup and test assertions inside requests.
• Utilities Layer: Shared helper scripts or functions to reuse across collections.
• Configuration Layer: Settings for collection runs, environment selection, and global variables.

Configuration Patterns for Postman Collections

• Environment Files: Use separate JSON files for each environment to store URLs, tokens, and credentials.
• Global Variables: Store values that are common across all environments, like API keys.
• Collection Variables: Variables scoped to a specific collection for modularity.
• Postman Config File: Use postman.config.json to define default environment and collection run settings.
• Secrets Management: Avoid hardcoding sensitive data; use environment variables or Postman's secret vault.

Test Reporting and CI/CD Integration

• Newman CLI: Run Postman collections from command line and generate reports in formats like HTML, JSON, or JUnit.
• CI/CD Integration: Integrate Newman runs into pipelines (Jenkins, GitHub Actions, GitLab CI) for automated testing.
• Report Visualization: Use tools like newman-reporter-html to create readable test reports.
• Fail Fast: Configure Newman to stop on first failure to save time.
• Notifications: Send test results to Slack, email, or dashboards after CI runs.

Best Practices for Creating Postman Collections

• Organize Requests Logically: Group related API calls in folders within collections for clarity.
• Use Environment Variables: Avoid hardcoding URLs and credentials; use variables for flexibility.
• Write Clear Test Scripts: Keep assertions simple and descriptive to understand failures easily.
• Reuse Scripts: Use pre-request and test scripts to avoid duplication and maintain consistency.
• Version Control Collections: Export collections and environments to JSON files and store in Git for collaboration.

Self Check Question

Where in this folder structure would you add a new collection for testing the Payment API?

Key Result

Organize API requests into collections with environment variables and scripts for reusable, maintainable automated API testing.

Practice

1. What is the main purpose of creating a collection in Postman?

easy

A. To group API requests for better organization

B. To write code in Postman

C. To change the API server settings

D. To create user accounts

Solution

1. Step 1: Understand what collections do

   Collections in Postman are used to group API requests together.

2. Step 2: Identify the main benefit

   This grouping helps organize requests and makes testing easier.

3. Final Answer:

   To group API requests for better organization -> Option A

4. Quick Check:

   Collections = Group API requests [OK]

Hint: Collections group requests to keep tests organized [OK]

Common Mistakes:

• Thinking collections are for coding
• Confusing collections with server settings
• Assuming collections create user accounts

2. Which of the following is the correct way to create a new collection in Postman?

easy

A. Go to settings and change the environment

B. Right-click on a request and select 'Delete'

C. Click the 'New' button and select 'Collection'

D. Open the console and type 'create collection'

Solution

1. Step 1: Locate how to create collections

   In Postman, you create collections by clicking the 'New' button.

2. Step 2: Select the correct option

   After clicking 'New', you choose 'Collection' to create one.

3. Final Answer:

   Click the 'New' button and select 'Collection' -> Option C

4. Quick Check:

   Create collection = New button > Collection [OK]

Hint: Use 'New' button to start creating collections [OK]

Common Mistakes:

• Trying to delete requests to create collections
• Changing environment instead of creating collections
• Typing commands in console to create collections

3. Consider this scenario: You create a collection named 'User APIs' and add three requests to it. What will you see in the Postman sidebar?

medium

A. A folder named 'User APIs' containing the three requests

B. Three separate collections named after each request

C. Only one request visible without any collection

D. An error message about duplicate requests

Solution

1. Step 1: Understand collection structure

   A collection acts like a folder holding multiple requests.

2. Step 2: Visualize sidebar display

   The sidebar shows the collection name with its requests nested inside.

3. Final Answer:

   A folder named 'User APIs' containing the three requests -> Option A

4. Quick Check:

   Collection = Folder with requests inside [OK]

Hint: Collections appear as folders with requests inside [OK]

Common Mistakes:

• Thinking each request becomes its own collection
• Expecting requests to appear without collections
• Assuming errors occur when adding multiple requests

4. You tried to add a request to a collection but it did not appear inside. What is the most likely mistake?

medium

A. You created a new collection instead of adding to existing one

B. You forgot to save the request after adding it to the collection

C. You closed Postman before adding the request

D. You changed the environment instead of adding the request

Solution

1. Step 1: Check the process of adding requests

   After adding a request to a collection, you must save it to confirm.

2. Step 2: Identify common user error

   Forgetting to save means the request won't appear in the collection.

3. Final Answer:

   You forgot to save the request after adding it to the collection -> Option B

4. Quick Check:

   Save request after adding = request appears [OK]

Hint: Always save requests after adding to collections [OK]

Common Mistakes:

• Assuming creating new collection adds request automatically
• Closing app before saving changes
• Mixing environment changes with request additions

5. You want to share a set of API tests with your team using Postman collections. Which steps should you follow to create and share the collection properly?

hard

A. Export environment variables only without collections

B. Create individual requests without collections and email each request

C. Change the workspace settings to public without creating collections

D. Create a collection, add requests, save it, then use the 'Share' option to send a link

Solution

1. Step 1: Create and organize requests in a collection

   First, create a collection and add all relevant API requests to it.

2. Step 2: Save the collection and use sharing features

   Save the collection and then use Postman's 'Share' option to generate a link or invite team members.

3. Final Answer:

   Create a collection, add requests, save it, then use the 'Share' option to send a link -> Option D

4. Quick Check:

   Share collections by saving and using Share link [OK]

Hint: Save collections and use Share link to share with team [OK]

Common Mistakes:

• Sharing requests individually instead of collections
• Only exporting environment variables
• Changing workspace without creating collections