Folder hierarchy in Postman - Build an Automation Script

Verify folder hierarchy creation and request organization in Postman

Preconditions (2)

Step 1: Click on 'New' button and select 'Folder' to create a new folder named 'User APIs'

Step 2: Inside 'User APIs' folder, create two subfolders named 'Authentication' and 'Profile'

Step 3: Add a GET request named 'Login Status' inside 'Authentication' folder with URL 'https://api.example.com/login/status'

Step 4: Add a GET request named 'Get Profile' inside 'Profile' folder with URL 'https://api.example.com/user/profile'

Step 5: Verify that the folder 'User APIs' contains the two subfolders 'Authentication' and 'Profile'

Step 6: Verify that 'Authentication' folder contains the 'Login Status' request

Step 7: Verify that 'Profile' folder contains the 'Get Profile' request

✅ Expected Result: Folder 'User APIs' is created with subfolders 'Authentication' and 'Profile'. Each subfolder contains the correct requests as named and with correct URLs.

Automation Requirements - Postman Collection Runner with pm scripting

Assertions Needed:

Verify folder structure exists as created

Verify requests exist in correct folders

Verify request URLs are correct

Best Practices:

Use Postman pm API to access folder and request details

Use descriptive assertion messages

Organize tests logically by folder

Avoid hardcoding folder IDs; use folder names

Automated Solution

Postman

const collection = pm.collectionVariables.toObject();

// Function to find folder by name
function findFolderByName(folders, name) {
    return folders.find(folder => folder.name === name);
}

// Access folders from collection
const folders = pm.collection.folders.toObject();

// Verify 'User APIs' folder exists
const userApisFolder = findFolderByName(folders, 'User APIs');
pm.test('User APIs folder exists', () => {
    pm.expect(userApisFolder).to.not.be.undefined;
});

// Verify subfolders
const subfolders = userApisFolder ? userApisFolder.folders : [];
const authFolder = findFolderByName(subfolders, 'Authentication');
const profileFolder = findFolderByName(subfolders, 'Profile');

pm.test('Authentication subfolder exists', () => {
    pm.expect(authFolder).to.not.be.undefined;
});

pm.test('Profile subfolder exists', () => {
    pm.expect(profileFolder).to.not.be.undefined;
});

// Verify requests in Authentication folder
const authRequests = authFolder ? authFolder.requests : [];
const loginStatusRequest = authRequests.find(req => req.name === 'Login Status');
pm.test('Login Status request exists in Authentication folder', () => {
    pm.expect(loginStatusRequest).to.not.be.undefined;
    pm.expect(loginStatusRequest.request.url.toString()).to.eql('https://api.example.com/login/status');
});

// Verify requests in Profile folder
const profileRequests = profileFolder ? profileFolder.requests : [];
const getProfileRequest = profileRequests.find(req => req.name === 'Get Profile');
pm.test('Get Profile request exists in Profile folder', () => {
    pm.expect(getProfileRequest).to.not.be.undefined;
    pm.expect(getProfileRequest.request.url.toString()).to.eql('https://api.example.com/user/profile');
});

This script uses Postman's pm API to check the folder hierarchy and requests inside the collection.

First, it finds the main folder 'User APIs'. Then it checks for the two subfolders 'Authentication' and 'Profile'.

For each subfolder, it verifies that the expected requests exist and that their URLs match the expected values.

Assertions use pm.expect with clear messages to confirm the structure and data are correct.

This approach avoids hardcoding folder IDs by searching folders by name, making the test more maintainable.

Common Mistakes - 3 Pitfalls

Hardcoding folder IDs instead of using folder names

Not verifying the request URLs, only checking request names

Using pm.test inside loops without proper closure

Bonus Challenge

Now add data-driven testing to verify folder hierarchy and requests for 3 different collections with different folder names and requests.

Show Hint

Practice

1. What is the main purpose of using folders in Postman collections?

easy

A. To create user accounts in Postman

B. To write code for API endpoints

C. To change the API server URL

D. To organize API requests into groups for better management

Solution

1. Step 1: Understand folder usage in Postman

   Folders group related API requests inside a collection to keep things organized.

2. Step 2: Identify the correct purpose

   Folders help manage and run related tests easily by grouping requests logically.

3. Final Answer:

   To organize API requests into groups for better management -> Option D

4. Quick Check:

   Folder purpose = Organize requests [OK]

Hint: Folders group requests logically for easy management [OK]

Common Mistakes:

• Thinking folders are for coding API logic
• Confusing folders with environment settings
• Assuming folders change server URLs

2. Which of the following is the correct way to create a folder inside a Postman collection?

easy

A. Right-click the collection and select 'Add Folder'

B. Click 'New' and select 'Environment'

C. Edit the collection and type folder name in URL

D. Drag and drop requests outside the collection

Solution

1. Step 1: Recall Postman UI actions

   To create a folder, you right-click the collection and choose 'Add Folder'.

2. Step 2: Eliminate incorrect options

   Options B, C, and D do not create folders; they relate to environments, editing URLs, or invalid drag actions.

3. Final Answer:

   Right-click the collection and select 'Add Folder' -> Option A

4. Quick Check:

   Create folder = Right-click collection + Add Folder [OK]

Hint: Right-click collection to add folder quickly [OK]

Common Mistakes:

• Choosing environment creation instead of folder
• Trying to create folder by editing URLs
• Dragging requests outside collections

3. Given this folder structure in Postman:

Collection
 ├─ Folder A
 │   ├─ Request 1
 │   └─ Request 2
 └─ Folder B
     └─ Request 3

If you run Folder A, which requests will execute?

medium

A. Request 1 and Request 2

B. Request 1, Request 2, and Request 3

C. Only Request 3

D. No requests will run

Solution

1. Step 1: Understand folder execution scope

   Running a folder executes only the requests inside that folder, not others.

2. Step 2: Identify requests inside Folder A

   Folder A contains Request 1 and Request 2, so only these run.

3. Final Answer:

   Request 1 and Request 2 -> Option A

4. Quick Check:

   Run folder = only its requests [OK]

Hint: Run folder runs only requests inside it [OK]

Common Mistakes:

• Assuming all collection requests run
• Including requests from other folders
• Thinking no requests run when folder runs

4. You created a folder inside a collection but it does not show any requests when you run it. What is the most likely reason?

medium

A. The collection is deleted

B. Postman is offline

C. The folder is empty and has no requests inside

D. You did not save the collection

Solution

1. Step 1: Analyze folder content

   If a folder runs but no requests execute, it likely has no requests inside.

2. Step 2: Check other options

   Collection deletion or Postman offline would cause errors, not empty runs. Not saving collection would prevent folder creation.

3. Final Answer:

   The folder is empty and has no requests inside -> Option C

4. Quick Check:

   Empty folder = no requests run [OK]

Hint: Check if folder contains requests before running [OK]

Common Mistakes:

• Assuming collection deletion causes empty folder run
• Blaming offline status without error
• Forgetting to add requests to folder

5. You want to run tests only for a specific group of related API requests in Postman. How should you organize your collection to achieve this efficiently?

hard

A. Add all requests directly to the collection without folders

B. Create a folder inside the collection and add those requests to it

C. Create multiple collections for each request

D. Use environment variables to filter requests

Solution

1. Step 1: Understand grouping for selective runs

   Folders group related requests so you can run them together easily.

2. Step 2: Evaluate other options

   Multiple collections for each request is inefficient; no folders means no grouping; environment variables do not filter requests.

3. Final Answer:

   Create a folder inside the collection and add those requests to it -> Option B

4. Quick Check:

   Group requests in folder for selective runs [OK]

Hint: Use folders to group and run related requests [OK]

Common Mistakes:

• Creating too many collections for single requests
• Not using folders and running all requests
• Misusing environment variables for request grouping