Request descriptions and documentation in Postman - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to add a description to a Postman request.

Postman

{
  "info": {
    "name": "Sample Request",
    "description": [1]
  }
}

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

Anull

B12345

C"This is a test request"

Dtrue

Attempts:

3 left

💡 Hint

Common Mistakes

Using a number or boolean instead of a string for description.

Leaving the description empty or null.

The description field should be a string explaining the request. Option C correctly provides a string description.

2fill in blank

medium

Complete the code to add a description to a Postman request body.

Postman

{
  "request": {
    "body": {
      "mode": "raw",
      "raw": "{\"name\": \"John\"}",
      "options": {
        "raw": {
          "language": "json",
          "description": [1]
        }
      }
    }
  }
}

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

A"User data in JSON format"

Bfalse

C123

Dnull

Attempts:

3 left

💡 Hint

Common Mistakes

Using non-string values for description.

Confusing description with other fields like language.

The description inside the body options should be a string explaining the body content. Option A correctly describes the JSON data.

3fill in blank

hard

Fix the error in the request description field to make it valid JSON.

Postman

{
  "info": {
    "name": "Test Request",
    "description": [1]
  }
}

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

AA valid description

Btrue

C123

D"A valid description"

Attempts:

3 left

💡 Hint

Common Mistakes

Leaving the description unquoted causing JSON syntax errors.

Using numbers or booleans instead of strings.

The description must be a string enclosed in quotes to be valid JSON. Option D correctly uses quotes.

4fill in blank

hard

Fill both blanks to add a description and a summary to a Postman request documentation.

Postman

{
  "item": [
    {
      "name": "Get User",
      "request": {
        "description": [1]
      },
      "event": [
        {
          "listen": "test",
          "script": {
            "exec": [
              "// Test script",
              "// Summary: [2]"
            ]
          }
        }
      ]
    }
  ]
}

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

A"Fetch user details by ID"

B"Check user data correctness"

C"Summary: Verify user retrieval"

D"Test user response format"

Attempts:

3 left

💡 Hint

Common Mistakes

Mixing up description and summary texts.

Using non-string values or missing quotes.

The description explains the request purpose (A), and the summary in the test script comments (C) describes the test goal.

5fill in blank

hard

Fill all three blanks to document a Postman request with description, test summary, and assertion message.

Postman

{
  "item": [
    {
      "name": "Create Item",
      "request": {
        "description": [1]
      },
      "event": [
        {
          "listen": "test",
          "script": {
            "exec": [
              "pm.test('[2]', function () {",
              "  pm.response.to.have.status(201);",
              "  pm.expect(pm.response.text()).to.include('[3]');",
              "});"
            ]
          }
        }
      ]
    }
  ]
}

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

A"Create a new item in the database"

B"Status code is 201 Created"

C"Item created successfully"

D"Check response time"

Attempts:

3 left

💡 Hint

Common Mistakes

Using unrelated or vague test names.

Not matching assertion messages to expected response.

The description (A) explains the request. The test name (B) describes the assertion. The assertion message (C) confirms success.

Practice

1. What is the main purpose of adding a description to a Postman request?

easy

A. To run the request faster

B. To change the request URL automatically

C. To explain what the API request does for better understanding

D. To hide the request from other users

Solution

1. Step 1: Understand the role of descriptions in Postman

   Descriptions provide clear notes about what each API request does, helping users understand its purpose.

2. Step 2: Identify the correct purpose among options

   Only To explain what the API request does for better understanding correctly states that descriptions explain the API request for better understanding.

3. Final Answer:

   To explain what the API request does for better understanding -> Option C

4. Quick Check:

   Descriptions clarify request purpose = A [OK]

Hint: Descriptions explain requests clearly for users [OK]

Common Mistakes:

• Thinking descriptions change request behavior
• Assuming descriptions speed up requests
• Believing descriptions hide requests

2. Which Postman tab should you use to add a description to an API request?

easy

A. Description tab

B. Tests tab

C. Headers tab

D. Body tab

Solution

1. Step 1: Identify where descriptions are added in Postman

   Descriptions are added in the Description tab of a request to provide notes and explanations.

2. Step 2: Match the correct tab with the description function

   The Description tab is designed specifically for adding descriptive text, unlike Tests, Headers, or Body tabs.

3. Final Answer:

   Description tab -> Option A

4. Quick Check:

   Description tab holds notes = B [OK]

Hint: Use Description tab to add notes to requests [OK]

Common Mistakes:

• Confusing Description tab with Tests tab
• Trying to add descriptions in Headers or Body tabs
• Not knowing where to write request notes

3. Consider this Postman request description snippet:

"Fetches user data by ID. Returns 404 if user not found."

What is the main benefit of including this description?

medium

A. It informs users what the request does and possible responses

B. It automatically handles 404 errors in the request

C. It changes the API response format

D. It encrypts the user data in the response

Solution

1. Step 1: Analyze the description content

   The description explains the request purpose and what happens if the user is not found (404 error).

2. Step 2: Determine the benefit of this explanation

   This helps users understand the request behavior and expected responses, improving clarity.

3. Final Answer:

   It informs users what the request does and possible responses -> Option A

4. Quick Check:

   Description explains purpose and responses = A [OK]

Hint: Descriptions tell what request does and possible results [OK]

Common Mistakes:

• Thinking descriptions affect request execution
• Assuming descriptions change API data
• Believing descriptions encrypt or secure data

4. You added a description to a Postman request but it does not appear in the documentation. What is the most likely reason?

medium

A. You added the description in the Tests tab instead of Description tab

B. You forgot to save the request after adding the description

C. Descriptions are not supported in Postman documentation

D. The request URL is invalid

Solution

1. Step 1: Check how descriptions appear in documentation

   Descriptions must be saved with the request to show up in generated documentation.

2. Step 2: Identify common mistakes preventing description display

   Not saving changes after editing description is a common cause; descriptions are supported and must be in Description tab.

3. Final Answer:

   You forgot to save the request after adding the description -> Option B

4. Quick Check:

   Unsaved description won't show = C [OK]

Hint: Always save request after editing description [OK]

Common Mistakes:

• Adding description in wrong tab
• Assuming descriptions don't show in docs
• Ignoring save button after editing

5. You want to document a complex API request in Postman that has multiple query parameters and possible error codes. Which approach best improves clarity in the request description?

hard

A. Write a short description and add details in the Tests tab

B. Leave the description empty and rely on the request name only

C. Add only the URL in the description without explanations

D. Write a detailed description listing each query parameter and error code with explanations

Solution

1. Step 1: Understand documentation needs for complex requests

   Complex requests benefit from detailed descriptions explaining parameters and error codes for user clarity.

2. Step 2: Evaluate options for best clarity

   Write a detailed description listing each query parameter and error code with explanations provides detailed, helpful notes; other options omit important info or place it in wrong tabs.

3. Final Answer:

   Write a detailed description listing each query parameter and error code with explanations -> Option D

4. Quick Check:

   Detailed descriptions improve clarity = D [OK]

Hint: Detail parameters and errors in description for clarity [OK]

Common Mistakes:

• Skipping detailed notes for complex requests
• Putting explanations in Tests tab instead of Description
• Relying only on request name without description