Example requests and responses in Postman - Framework Patterns

Framework Mode - Example requests and responses

Folder Structure

postman_collection_project/
├── collections/
│   └── api_tests.postman_collection.json
├── environments/
│   ├── dev_environment.postman_environment.json
│   └── prod_environment.postman_environment.json
├── tests/
│   └── example_test_script.js
├── reports/
│   └── test_report.html
├── data/
│   └── test_data.json
└── README.md
    

Test Framework Layers

• Collections: Store API requests grouped by feature or endpoint.
• Environments: Define variables like base URLs, tokens for different setups (dev, prod).
• Tests: Scripts that run assertions on API responses using Postman test scripts or external JS.
• Data: External JSON files for data-driven testing (e.g., different user inputs).
• Reports: Generated test run reports showing pass/fail results.

Configuration Patterns

Use Postman environments to manage configuration:

• Environment Variables: Store base URLs, API keys, tokens to switch easily between dev, test, prod.
• Global Variables: For values shared across all environments.
• Pre-request Scripts: Set or update tokens dynamically before requests.
• Collection Variables: Variables scoped to a collection for modularity.

Test Reporting and CI/CD Integration

• Use Newman (Postman CLI) to run collections from command line.
• Generate HTML or JSON reports with Newman reporters.
• Integrate Newman runs into CI/CD pipelines (Jenkins, GitHub Actions) to automate API tests on code changes.
• Reports show which requests passed or failed with detailed assertion messages.

Best Practices

1. Organize requests logically in collections by feature or endpoint.
2. Use environment variables to avoid hardcoding URLs or secrets.
3. Write clear, simple test scripts with meaningful assertions.
4. Keep test data separate from requests for easy updates and reusability.
5. Automate test runs with Newman and integrate with CI/CD for continuous feedback.

Self Check

Where would you add a new API request for user login in this framework structure?

Key Result

Organize Postman API tests with collections, environments, scripts, and automate runs using Newman for reliable API testing.

Practice

1. What is the main purpose of example requests and responses in Postman?

easy

A. To design website layouts

B. To create new APIs automatically

C. To write backend server code

D. To show how to use an API step-by-step

Solution

1. Step 1: Understand the role of example requests

   Example requests demonstrate how to call an API with real data.

2. Step 2: Understand the role of example responses

   Example responses show what the API returns for those requests.

3. Final Answer:

   To show how to use an API step-by-step -> Option D

4. Quick Check:

   Example requests + responses = API usage guide [OK]

Hint: Examples explain API use clearly and simply [OK]

Common Mistakes:

• Thinking examples create APIs
• Confusing examples with coding
• Assuming examples design UI

2. Which of the following is the correct way to add an example response in Postman?

easy

A. Change the request method to POST

B. Click 'Save Response' after sending a request

C. Edit the URL in the Params tab

D. Write code in the Tests tab

Solution

1. Step 1: Identify how to save example responses

   After sending a request, Postman allows saving the response as an example.

2. Step 2: Confirm the correct action

   Clicking 'Save Response' saves the current response as an example for future reference.

3. Final Answer:

   Click 'Save Response' after sending a request -> Option B

4. Quick Check:

   Save response = example response [OK]

Hint: Save response after request to create example [OK]

Common Mistakes:

• Trying to add examples by editing URL
• Confusing Tests tab with examples
• Changing method does not save examples

3. Given this example request in Postman:

{
  "name": "Alice",
  "age": 30
}

And this example response:

{
  "id": 101,
  "name": "Alice",
  "age": 30
}

What does the response show?

medium

A. The API ignores the age field

B. The API returns an error because of missing fields

C. The API returns the user data with a new ID

D. The API returns only the ID

Solution

1. Step 1: Compare request and response fields

   The request sends name and age; the response adds an id field.

2. Step 2: Understand the meaning of added id

   The id is usually a unique identifier assigned by the API to the new user.

3. Final Answer:

   The API returns the user data with a new ID -> Option C

4. Quick Check:

   Response adds id to request data [OK]

Hint: Response adds new info like ID to request data [OK]

Common Mistakes:

• Assuming error without error message
• Ignoring added id field
• Thinking age is removed

4. You saved an example response in Postman, but it shows outdated data. What is the best way to fix this?

medium

A. Send the request again and save the new response as example

B. Edit the example response manually in the editor

C. Delete the request and create a new one

D. Change the request URL to a different API

Solution

1. Step 1: Identify how to update example responses

   Example responses reflect saved data; to update, you must get fresh data from the API.

2. Step 2: Choose the correct update method

   Sending the request again gets current data; saving it updates the example correctly.

3. Final Answer:

   Send the request again and save the new response as example -> Option A

4. Quick Check:

   Refresh example by resending and saving response [OK]

Hint: Resend request and save response to update example [OK]

Common Mistakes:

• Editing example manually can cause errors
• Deleting request is unnecessary
• Changing URL changes API, not example

5. You want to create an example request and response in Postman to show how to update a user's email. Which steps should you follow?

hard

A. Send a PUT request with new email, then save the response as example

B. Write the new email in the Tests tab and save the request

C. Change the request method to GET and save the response

D. Delete the user and create a new example request

Solution

1. Step 1: Use the correct HTTP method for update

   PUT is the standard method to update existing data like email.

2. Step 2: Save the response after sending the update request

   Saving the response as example shows the API's reply to the update.

3. Final Answer:

   Send a PUT request with new email, then save the response as example -> Option A

4. Quick Check:

   Update with PUT + save response example [OK]

Hint: Use PUT for update, then save response example [OK]

Common Mistakes:

• Using GET instead of PUT for update
• Editing Tests tab does not create examples
• Deleting user is unrelated