Why documentation improves API adoption in Postman - Test Your Understanding

Practice - 5 Tasks

1fill in blank

easy

Complete the code to set the request method to GET in Postman test script.

Postman

pm.request.method = '[1]';

Drag options to blanks, or click blank then click option'

AGET

BPOST

CPUT

DDELETE

Attempts:

3 left

💡 Hint

Common Mistakes

Using POST instead of GET for fetching data.

The GET method is used to retrieve data from an API. Setting pm.request.method to 'GET' ensures the request fetches data.

2fill in blank

medium

Complete the code to check if the response status code is 200 in a Postman test script.

Postman

pm.test('Status code is 200', function () { pm.response.to.have.status([1]); });

Drag options to blanks, or click blank then click option'

A404

B500

C200

D201

Attempts:

3 left

💡 Hint

Common Mistakes

Using 404 which means Not Found.

Status code 200 means the request was successful. This test checks if the API responded correctly.

3fill in blank

hard

Fix the error in the Postman test script to correctly check if the response body contains the key 'userId'.

Postman

pm.test('Response has userId', function () { pm.expect(pm.response.json()).to.have.[1]('userId'); });

Drag options to blanks, or click blank then click option'

Aproperty

Blength

Cstatus

Dheader

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'length' which checks array length, not keys.

The property assertion checks if the JSON response has a specific key like 'userId'.

4fill in blank

hard

Fill both blanks to create a test that checks if the response time is less than 500 milliseconds.

Postman

pm.test('Response time is fast', function () { pm.expect(pm.response.[1]).to.be.[2](500); });

Drag options to blanks, or click blank then click option'

AresponseTime

Bbelow

Cabove

Dstatus

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'above' which checks if response time is greater.

pm.response.responseTime gives the response time in ms. The below assertion checks if it is less than the given value.

5fill in blank

hard

Fill both blanks to write a test that verifies the JSON response has a 'name' key with value 'John'.

Postman

pm.test('Name is John', function () { pm.expect(pm.response.json().[1]).to.[2]('John'); });

Drag options to blanks, or click blank then click option'

Aname

Bhave

Cequal

Dlength

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'length' which is for size, not value equality.

This test accesses the 'name' key in the JSON response and asserts it is equal to 'John'.

Practice

1. Why is good documentation important for API adoption?

easy

A. It increases the API's runtime speed.

B. It helps developers understand and use the API faster.

C. It reduces the size of the API code.

D. It automatically fixes bugs in the API.

Solution

1. Step 1: Understand the role of documentation

   Documentation explains how to use the API, making it easier for developers to learn.

2. Step 2: Connect documentation to adoption speed

   Clear docs reduce confusion and speed up the learning process, encouraging adoption.

3. Final Answer:

   It helps developers understand and use the API faster. -> Option B

4. Quick Check:

   Good docs = faster understanding [OK]

Hint: Good docs speed up learning and usage [OK]

Common Mistakes:

• Confusing documentation with code performance
• Thinking docs fix bugs automatically
• Assuming docs reduce code size

2. Which of the following is a correct way to include an example in API documentation using Postman?

easy

A. console.log('Example');

B. function example() { return 123; }

C. SELECT * FROM users;

D. { "userId": 123, "name": "John" }

Solution

1. Step 1: Identify the correct example format for API docs

   API examples usually show JSON request or response bodies.

2. Step 2: Match the option with JSON format

   { "userId": 123, "name": "John" } shows a JSON object, which is typical for API examples.

3. Final Answer:

   { "userId": 123, "name": "John" } -> Option D

4. Quick Check:

   API examples = JSON format [OK]

Hint: API examples use JSON, not code functions [OK]

Common Mistakes:

• Using programming code instead of JSON
• Including SQL queries in API docs
• Confusing console logs with examples

3. Given this Postman documentation snippet:

{
  "id": 10,
  "status": "active"
}

What does this example help developers understand?

medium

A. The expected JSON response format from the API.

B. The database schema used by the API.

C. The JavaScript code to call the API.

D. The error messages returned by the API.

Solution

1. Step 1: Analyze the snippet content

   The snippet shows a JSON object with fields "id" and "status".

2. Step 2: Determine its purpose in docs

   This format is typical for showing what the API returns as a response.

3. Final Answer:

   The expected JSON response format from the API. -> Option A

4. Quick Check:

   JSON snippet = response format [OK]

Hint: JSON snippet shows response format [OK]

Common Mistakes:

• Confusing response format with database schema
• Thinking snippet is code to call API
• Assuming snippet shows error messages

4. You notice the API documentation in Postman is outdated and missing recent changes. What is the best way to fix this?

medium

A. Remove all examples to avoid confusion.

B. Ignore the documentation and rely on code comments.

C. Update the documentation to match the latest API changes.

D. Add unrelated API endpoints to distract users.

Solution

1. Step 1: Identify the problem with outdated docs

   Outdated docs cause confusion and reduce trust in the API.

2. Step 2: Choose the best fix

   Updating docs to reflect current API behavior keeps them useful and trustworthy.

3. Final Answer:

   Update the documentation to match the latest API changes. -> Option C

4. Quick Check:

   Keep docs updated = better trust [OK]

Hint: Always keep docs updated with API changes [OK]

Common Mistakes:

• Removing examples instead of updating
• Ignoring docs and relying on code only
• Adding unrelated info to docs

5. How does keeping API documentation updated in Postman reduce support requests from developers?

hard

A. Developers find answers quickly without needing extra help.

B. It automatically fixes bugs in the API code.

C. It increases the API's speed and performance.

D. It hides complex API features from developers.

Solution

1. Step 1: Understand the link between docs and support

   Clear, updated docs provide needed info, reducing confusion and questions.

2. Step 2: Explain how updated docs help developers

   Developers can solve problems themselves by reading docs, lowering support requests.

3. Final Answer:

   Developers find answers quickly without needing extra help. -> Option A

4. Quick Check:

   Updated docs = fewer support requests [OK]

Hint: Updated docs answer questions early [OK]

Common Mistakes:

• Thinking docs fix bugs automatically
• Confusing docs with API performance
• Assuming docs hide features