Building a Complete API Testing Workflow

# CHAPTER 19

Building a Complete API Testing Workflow #

1. Introduction #

2. Learning Objectives #

• Architect a logical Folder structure for a complex API.

• Implement an automated Authentication flow using variables.

• Write a sequential CRUD test suite (Create, Read, Update, Delete).

• Utilize postman.setNextRequest() for advanced flow control.

• Prepare a Collection for execution via the Collection Runner or Newman.

3. Beginner-Friendly Explanation #

1. 1. Wake up and log into the system (Auth).

1. 2. Remember the security badge (Variables).

1. 3. Build a new toy (POST).

1. 4. Verify the toy looks right (GET and Tests).

1. 5. Paint the toy a different color (PUT).

1. 6. Verify the new color (GET and Tests).

1. 7. Throw the toy in the trash to clean up (DELETE).

4. The Project Scenario #

• Base URL: https://api.fake-shop.com (We will assume this exists for the exercise).

• Goal: Verify that a user can log in, create a product, update its price, and delete it.

5. Step 1: Environment Setup #

1. 1. Create a new Environment called ShopAPI - Staging.

1. 2. Add variables:

• baseUrl = https://api.fake-shop.com

• adminemail = admin@shop.com

• adminpassword = secret123

• authtoken = (Leave blank)

• productid = (Leave blank)

6. Step 2: Collection & Folder Architecture #

• Folder 1: 01 - Authentication

• Folder 2: 02 - Product CRUD Flow

*Pro-tip: Numbering folders ensures the Collection Runner executes them in the exact order you want.*

7. Step 3: The Authentication Request (Request Chaining) #

• Method: POST

• URL: {{baseUrl}}/login

• Body:

{
  "email": "{{admin_email}}",
  "password": "{{admin_password}}"
}

• Tests Tab: This is the crucial chaining step!

pm.test("Status is 200", function () {
    pm.response.to.have.status(200);
});
// Save the token for the next requests
const res = pm.response.json();
pm.environment.set("auth_token", res.token);

8. Step 4: Collection-Level Authorization #

1. 4. In the Token field, type {{authtoken}}.

9. Step 5: The CRUD Flow (Create, Read, Update, Delete) #

Request A: Create Product

• Method: POST {{baseUrl}}/products

• Body: {"name": "Laptop", "price": 999}

• Tests: Assert 201 Created. Extract the ID: pm.environment.set("productid", pm.response.json().id);

• Method: GET {{baseUrl}}/products/{{productid}}

• Tests: Assert 200 OK. Assert name is "Laptop".

Request C: Update Product

• Method: PUT {{baseUrl}}/products/{{productid}}

• Method: DELETE {{baseUrl}}/products/{{productid}}

• Tests: Assert 204 No Content.

10. Step 6: Advanced Flow Control (Optional) #

if (pm.response.code !== 201) {
    console.log("Creation failed! Aborting the rest of the flow.");
    postman.setNextRequest(null); // Stops the runner instantly
}

11. Step 7: Execution and Reporting #

1. 1. Click the Collection name, click the ... menu, and select Run Collection.

1. 2. Ensure both folders (01 - Authentication and 02 - Product CRUD Flow) are checked.

1. 3. Select your ShopAPI - Staging environment.

1. 4. Click Run.

1. 5. Watch the beautiful green PASS badges cascade down the screen as Postman automatically logs in, saves the token, creates a product, saves the ID, updates it, and deletes it.

12. Best Practices for Workflows #

• Idempotency: A test suite should be able to run 1 time or 100 times in a row without breaking or polluting the database. Always clean up data (DELETE) at the end of a flow.

• Isolate Environments: Never run a destructive CRUD test suite like this against a Production database! You might accidentally delete real user data. Always use Staging or Local environments.

• Fail Fast: If a critical early step (like Login) fails, use postman.setNextRequest(null) to halt execution rather than letting 50 subsequent tests fail noisily.

13. Summary #

14. Next Chapter Recommendation #