Importing and exporting collections in Postman - Framework Patterns

Framework Mode - Importing and exporting collections

Folder Structure of a Postman Test Project

postman-project/
├── collections/
│   ├── user-authentication.postman_collection.json
│   ├── product-api.postman_collection.json
│   └── order-api.postman_collection.json
├── environments/
│   ├── dev.postman_environment.json
│   ├── staging.postman_environment.json
│   └── production.postman_environment.json
├── scripts/
│   ├── pre-request-scripts.js
│   └── test-scripts.js
├── exports/
│   └── exported-collections/
│       ├── user-authentication-export.json
│       └── product-api-export.json
└── README.md
  

Test Framework Layers in Postman Collections

• Collections Layer: Contains grouped API requests organized by feature or service.
• Environment Layer: Holds variables like URLs, tokens, and credentials for different environments.
• Scripts Layer: Includes pre-request scripts and test scripts to run before or after requests.
• Exports Layer: Stores exported collection files for sharing or backup.
• Configuration Layer: Manages environment files and global variables.

Configuration Patterns for Importing and Exporting Collections

• Importing Collections: Use Postman UI or CLI to import JSON files from the collections/ or exports/exported-collections/ folder.
• Exporting Collections: Export collections from Postman UI to JSON files saved in exports/exported-collections/ for version control or sharing.
• Environment Management: Keep environment JSON files in environments/ and import/export as needed to switch contexts.
• Version Control: Store exported collections and environments in Git or other VCS for team collaboration.

Test Reporting and CI/CD Integration

• Use Newman (Postman CLI) to run collections in CI/CD pipelines.
• Generate reports in formats like HTML or JSON using Newman reporters.
• Integrate test runs with CI tools (Jenkins, GitHub Actions) to automate API testing on code changes.
• Store exported collections in the repository to ensure consistent test runs across environments.

Best Practices for Importing and Exporting Collections

• Keep collections small and focused on specific API features for easier maintenance.
• Use meaningful names for exported collection files including version or date.
• Regularly export collections after updates to keep backups and share with the team.
• Use environment variables to avoid hardcoding sensitive data in collections.
• Document collection purpose and usage in README or Postman description fields.

Self-Check Question

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

Key Result

Organize Postman collections and environments in dedicated folders, export/import JSON files for sharing and automation.

Practice

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

easy

A. To add existing API tests into Postman for use

B. To delete all current tests in Postman

C. To export tests to a JSON file

D. To create a new API from scratch

Solution

1. Step 1: Understand importing collections

   Importing collections means bringing existing API tests into Postman so you can use or modify them.

2. Step 2: Differentiate from exporting and creating

   Exporting saves tests out of Postman, and creating new APIs is different from importing.

3. Final Answer:

   To add existing API tests into Postman for use -> Option A

4. Quick Check:

   Import = Add existing tests [OK]

Hint: Import means bringing tests in, not creating or deleting [OK]

Common Mistakes:

• Confusing import with export
• Thinking import deletes tests
• Assuming import creates new APIs

2. Which file format is used when exporting a collection from Postman?

easy

A. .xml

B. .csv

C. .json

D. .txt

Solution

1. Step 1: Identify export file format

   Postman exports collections as JSON files, which store structured data about API tests.

2. Step 2: Exclude other formats

   XML, TXT, and CSV are not used by Postman for exporting collections.

3. Final Answer:

   .json -> Option C

4. Quick Check:

   Exported collections use JSON files [OK]

Hint: Postman collections export as JSON files only [OK]

Common Mistakes:

• Choosing XML or CSV instead of JSON
• Confusing export format with import options
• Assuming text files are used

3. You exported a collection from Postman and shared the JSON file. Your teammate imports it but sees no requests. What is the likely cause?

medium

A. Postman does not support importing JSON files

B. The JSON file was empty or corrupted

C. The teammate did not restart Postman after import

D. The collection was exported in XML format

Solution

1. Step 1: Check file integrity

   If the imported collection shows no requests, the JSON file might be empty or corrupted, causing no data to load.

2. Step 2: Verify import support and format

   Postman supports JSON imports, and restarting is not required. Exporting in XML is not possible, so that is invalid.

3. Final Answer:

   The JSON file was empty or corrupted -> Option B

4. Quick Check:

   Empty/corrupt JSON causes no requests on import [OK]

Hint: Empty or broken JSON files cause empty imports [OK]

Common Mistakes:

• Thinking Postman can't import JSON
• Assuming restart is needed after import
• Believing XML export is possible

4. You tried to export a collection but the export button is disabled. What should you check to fix this?

medium

A. Ensure a collection is selected in Postman

B. Restart your computer immediately

C. Change the export file format to XML

D. Uninstall and reinstall Postman

Solution

1. Step 1: Verify collection selection

   The export button is disabled if no collection is selected. Selecting a collection enables export.

2. Step 2: Exclude unnecessary actions

   Restarting, changing to XML (unsupported), or reinstalling are not needed to enable export.

3. Final Answer:

   Ensure a collection is selected in Postman -> Option A

4. Quick Check:

   Export button needs a selected collection [OK]

Hint: Select a collection first to enable export button [OK]

Common Mistakes:

• Trying unsupported XML format
• Restarting unnecessarily
• Reinstalling Postman without checking selection

5. You want to share a set of API tests with a teammate who uses Postman. Which steps correctly describe exporting and importing the collection?

hard

A. Copy the collection URL, teammate pastes it in browser to import

B. Export the collection as CSV, send the file, teammate imports CSV in Postman

C. Export the collection as XML, send the file, teammate imports XML in Postman

D. Export the collection as JSON, send the file, teammate imports JSON in Postman

Solution

1. Step 1: Export collection as JSON

   Postman exports collections only as JSON files for sharing or backup.

2. Step 2: Teammate imports JSON file

   The teammate imports the JSON file into their Postman app to get the same tests.

3. Final Answer:

   Export the collection as JSON, send the file, teammate imports JSON in Postman -> Option D

4. Quick Check:

   Export and import use JSON files [OK]

Hint: Always export/import collections as JSON files [OK]

Common Mistakes:

• Using CSV or XML formats
• Thinking URL copy imports collections
• Skipping export step