Query parameters in Postman - Framework Patterns

Framework Mode - Query parameters

Folder Structure for Postman Test Collections

postman-project/
├── collections/
│   ├── user-api.postman_collection.json
│   ├── product-api.postman_collection.json
│   └── order-api.postman_collection.json
├── environments/
│   ├── dev.postman_environment.json
│   ├── staging.postman_environment.json
│   └── prod.postman_environment.json
├── scripts/
│   ├── pre-request-scripts.js
│   └── test-scripts.js
├── data/
│   └── query-params-data.json
├── README.md
└── postman.config.json
  

Test Framework Layers in Postman

• Collections: Group of API requests organized by feature or service. Each request can include query parameters.
• Environments: Store variables like base URLs, API keys, and environment-specific data.
• Pre-request Scripts: JavaScript code that runs before a request to set or modify query parameters dynamically.
• Tests: JavaScript assertions that validate response data and status codes after request execution.
• Data Files: JSON or CSV files used for data-driven testing, including sets of query parameters.

Configuration Patterns for Query Parameters in Postman

• Environment Variables: Define query parameter values as variables in environment files (e.g., {{userId}}) to switch easily between environments.
• Collection Variables: Use collection-level variables for common query parameters shared across requests.
• Pre-request Scripts: Dynamically build or modify query parameters before sending requests, useful for timestamps or tokens.
• Data-driven Testing: Use external JSON or CSV files to run the same request multiple times with different query parameter values.

Test Reporting and CI/CD Integration

• Newman CLI: Run Postman collections from the command line and generate reports in formats like HTML, JSON, or JUnit XML.
• CI/CD Pipelines: Integrate Newman runs into pipelines (e.g., GitHub Actions, Jenkins) to automate API tests with query parameters on each code change.
• Report Visualization: Use tools like newman-reporter-html to create easy-to-read test reports showing pass/fail results for requests with query parameters.

Best Practices for Query Parameters in Postman Frameworks

• Use Variables for Flexibility: Always use environment or collection variables for query parameters to avoid hardcoding values.
• Keep Collections Organized: Group requests logically and name them clearly to reflect the query parameters they test.
• Validate Query Parameter Effects: Write tests that assert the API response changes correctly when query parameters vary.
• Use Data Files for Coverage: Employ data-driven testing to cover multiple query parameter combinations efficiently.
• Document Parameters: Use Postman descriptions to explain the purpose and expected values of query parameters for team clarity.

Self-Check Question

Where in this Postman framework structure would you add a new query parameter for the "Get User" API request?

Key Result

Organize Postman collections with environment variables and data-driven tests to manage query parameters effectively.

Practice

1. What symbol is used to start query parameters in a URL when making an API request in Postman?

easy

A. Question mark (?)

B. Ampersand (&)

C. Hash (#)

D. Slash (/)

Solution

1. Step 1: Understand URL structure

   Query parameters always start after the base URL with a question mark to separate them from the path.

2. Step 2: Identify the correct symbol

   The question mark (?) is the standard symbol to begin query parameters in URLs.

3. Final Answer:

   Question mark (?) -> Option A

4. Quick Check:

   Query parameters start with ? = C [OK]

Hint: Query parameters always start with ? in URLs [OK]

Common Mistakes:

• Using & to start query parameters instead of ?
• Confusing # (fragment) with query start
• Starting query parameters with /

2. Which of the following is the correct way to add two query parameters named user and id with values alice and 123 respectively in Postman?

easy

A. ?user=alice&id=123

B. &user=alice&id=123

C. ?user=alice#id=123

D. ?user=alice;id=123

Solution

1. Step 1: Start query parameters with ?

   The first query parameter must start with a question mark (?).

2. Step 2: Separate multiple parameters with &

   Additional parameters are separated by an ampersand (&), so user=alice&id=123 is correct.

3. Final Answer:

   ?user=alice&id=123 -> Option A

4. Quick Check:

   First ? then & between parameters = A [OK]

Hint: Start with ? then separate params with & [OK]

Common Mistakes:

• Starting with & instead of ?
• Using # instead of & to separate parameters
• Using semicolon ; instead of &

3. Given the URL https://api.example.com/data?type=fruit&color=red, what will Postman send as query parameters?

medium

A. No query parameters sent

B. type=fruit only

C. type=fruit and color=red

D. color=red only

Solution

1. Step 1: Identify all query parameters after ?

   After the question mark, parameters are separated by &. Here, we have type=fruit and color=red.

2. Step 2: Confirm both parameters are included

   Both parameters will be sent in the request as key-value pairs.

3. Final Answer:

   type=fruit and color=red -> Option C

4. Quick Check:

   Both params after ? separated by & = D [OK]

Hint: All params after ? separated by & are sent [OK]

Common Mistakes:

• Ignoring second parameter after &
• Thinking only first parameter is sent
• Confusing fragment (#) with query parameters

4. You wrote the URL https://api.example.com/search?query=books&limit10 in Postman. What is wrong with this query parameter syntax?

medium

A. Extra '&' before 'limit10'

B. Missing '=' between 'limit' and '10'

C. Query parameters should start with '&' not '?'

D. Using '=' instead of ':' between key and value

Solution

1. Step 1: Check each query parameter format

   Each parameter must be in key=value format. Here, 'limit10' lacks '='.

2. Step 2: Identify missing '=' sign

   Correct syntax should be 'limit=10' to assign value 10 to key 'limit'.

3. Final Answer:

   Missing '=' between 'limit' and '10' -> Option B

4. Quick Check:

   Each param must be key=value, '=' missing = B [OK]

Hint: Check each param has key=value format [OK]

Common Mistakes:

• Omitting '=' between key and value
• Starting query with & instead of ?
• Using ':' instead of '='

5. You want to filter API results in Postman to show only active users with role 'admin' and limit results to 5. Which query parameter string correctly achieves this?

hard

A. ?status=active&role=admin&limit=5&

B. ?status=active&role=admin&limit5

C. ?status=active;role=admin;limit=5

D. ?status=active&role=admin&limit=5

Solution

1. Step 1: Use correct key=value pairs separated by &

   Each filter must be a key=value pair, separated by &. ?status=active&role=admin&limit=5 uses correct syntax.

2. Step 2: Avoid syntax errors like missing '=' or wrong separators

   ?status=active&role=admin&limit5 misses '=' in limit, C uses semicolons instead of &, D has extra trailing & which is invalid.

3. Final Answer:

   ?status=active&role=admin&limit=5 -> Option D

4. Quick Check:

   All params key=value separated by & = A [OK]

Hint: Use key=value pairs separated by & without extra symbols [OK]

Common Mistakes:

• Missing '=' in parameters
• Using semicolons instead of &
• Adding extra & at the end