Request descriptions and documentation in Postman

Introduction

Request descriptions and documentation help explain what each API request does. This makes it easier for anyone using or testing the API to understand its purpose.

When sharing your API collection with teammates so they know what each request does.

When creating tests to ensure the API behaves as expected and you want clear notes.

When maintaining or updating APIs later and you need reminders of each request's role.

When onboarding new team members who need to learn the API quickly.

When generating automated API documentation for users or clients.

Syntax

Postman

In Postman, add a description to a request by clicking the 'Description' tab below the request URL field and typing your notes in Markdown or plain text.

Descriptions support Markdown formatting for better readability.

You can also add descriptions to collections and folders for overall context.

Examples

This simple description tells anyone what the GET request does.

Postman

GET https://api.example.com/users

Description:
Fetches a list of all users in the system.

Here, the description explains the purpose and what data is needed.

Postman

POST https://api.example.com/users

Description:
Creates a new user. Requires JSON body with 'name' and 'email' fields.

This helps testers know how the update works and what to expect.

Postman

PUT https://api.example.com/users/123

Description:
Updates user with ID 123. Only fields provided in the body will be changed.

Sample Program

This Postman request logs in a user. The description explains its purpose. The tests check that the login was successful and a token is returned.

Postman

POST https://api.example.com/login

Description:
Logs in a user with email and password.

Body (JSON):
{
  "email": "[e-mail]",
  "password": "securepass"
}

Tests:
pm.test("Status code is 200", function () {
  pm.response.to.have.status(200);
});

pm.test("Response has token", function () {
  pm.expect(pm.response.json()).to.have.property('token');
});

Important Notes

Good descriptions save time and reduce confusion during testing.

Keep descriptions clear and concise, avoid technical jargon if possible.

Update descriptions if the API changes to keep documentation accurate.

Summary

Descriptions explain what each API request does.

They help testers and developers understand and use the API correctly.

Use Postman's description tab to add clear, helpful notes to requests.

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