Description formatting (Markdown) in Postman

Introduction

Markdown helps you write clear and easy-to-read descriptions in Postman. It makes your test details look neat and organized.

You want to explain what a test or request does in Postman.

You need to add instructions or notes for your team in the test descriptions.

You want to highlight important parts like warnings or tips in your test cases.

You want to organize your test documentation with headings and lists.

You want to add links or images to make your test info more helpful.

Syntax

Postman

# Heading 1
## Heading 2
**bold text**
*italic text*
- List item
[Link text](https://example.com)
`inline code`
```
code block
```

Use # for headings, more # means smaller heading.

Use **bold** or *italic* to emphasize text.

Examples

A main heading with a short description below.

Postman

# Test Case Title
This test checks the login feature.

A simple bullet list to show test steps.

Postman

- Step 1: Open the app
- Step 2: Enter username
- Step 3: Enter password
- Step 4: Click login

A clickable link to helpful documentation.

Postman

For more info, visit [Postman Docs](https://learning.postman.com/).

Inline code formatting to highlight code snippets.

Postman

Use `pm.expect(response.code).to.eql(200);` to check status code.

Sample Program

This description uses headings, lists, and a code block to explain the login test clearly.

Postman

# Login Test
This test verifies the login API.

- Send POST request to /login
- Check response status is 200
- Check response body has token

```javascript
pm.test('Status code is 200', () => {
    pm.response.to.have.status(200);
});

pm.test('Response has token', () => {
    const jsonData = pm.response.json();
    pm.expect(jsonData.token).to.exist;
});
```

Important Notes

Markdown works in Postman descriptions.

Preview your markdown in Postman to see how it looks before sharing.

Keep descriptions short and clear for easy understanding.

Summary

Markdown makes your Postman descriptions neat and readable.

Use headings, lists, bold, italics, links, and code blocks to organize info.

Clear descriptions help your team understand tests better.

Practice

1. What is the main purpose of using Markdown in Postman descriptions?

easy

A. To store environment variables

B. To make descriptions neat and easy to read

C. To change the API request method

D. To write code that runs tests automatically

Solution

1. Step 1: Understand Markdown's role in Postman

   Markdown is used to format text, making it clear and organized.

2. Step 2: Identify the purpose of descriptions

   Descriptions help explain tests and requests clearly to the team.

3. Final Answer:

   To make descriptions neat and easy to read -> Option B

4. Quick Check:

   Markdown = format text [OK]

Hint: Markdown formats text for clarity [OK]

Common Mistakes:

• Confusing Markdown with test automation
• Thinking Markdown changes API methods
• Assuming Markdown stores variables

2. Which of the following is the correct way to make text bold in a Postman description using Markdown?

easy

A. *bold text*

B. _bold text_

C. `bold text`

D. **bold text**

Solution

1. Step 1: Recall Markdown syntax for bold text

   Bold text is created by wrapping text with double asterisks ** like **bold**.

2. Step 2: Compare options

   **bold text** uses **bold text**, which is correct. *bold text* or _bold text_ use single * or _, which make italics. `bold text` uses backticks for code formatting.

3. Final Answer:

   **bold text** -> Option D

4. Quick Check:

   Bold = **text** [OK]

Hint: Use double asterisks for bold text [OK]

Common Mistakes:

• Using single asterisk for bold (makes italics)
• Using backticks instead of asterisks
• Confusing italics and bold syntax

3. Given this Postman description snippet using Markdown:

### Test Steps
1. Send request
2. Check response
- Status code should be 200
- Body should contain 'success'

What will the rendered description look like?

medium

A. A heading 'Test Steps' followed by a numbered list with two items and a bulleted list under the second item

B. Plain text with no formatting

C. A bulleted list only with no heading

D. A numbered list with four items and no heading

Solution

1. Step 1: Interpret Markdown syntax

   ### creates a heading. Numbers create a numbered list. Hyphens create bullet points.

2. Step 2: Analyze the structure

   Heading 'Test Steps' appears. Then a numbered list with two items followed by a bulleted list with two points under the second item.

3. Final Answer:

   A heading 'Test Steps' followed by a numbered list with two items and a bulleted list under the second item -> Option A

4. Quick Check:

   ### = heading, 1./2. = numbered list, - = bullets [OK]

Hint: ### = heading, numbers = list, - = bullets [OK]

Common Mistakes:

• Ignoring nested lists
• Thinking numbers create bullets
• Missing the heading formatting

4. You wrote this Markdown in a Postman description:

**Test Result:
Passed**

But it does not show bold text as expected. What is the error?

medium

A. Newline inside ** breaks bold formatting; use inline text instead

B. Missing closing ** at the end

C. Markdown does not support bold in Postman

D. You must use single asterisks for bold

Solution

1. Step 1: Understand Markdown bold syntax

   Bold text must be continuous inside ** without line breaks.

2. Step 2: Identify the problem with newline

   Newline inside ** causes Markdown to break formatting, so 'Passed' is not bold.

3. Final Answer:

   Newline inside ** breaks bold formatting; use inline text instead -> Option A

4. Quick Check:

   Bold text must be on one line [OK]

Hint: Keep bold text on one line [OK]

Common Mistakes:

• Adding line breaks inside bold markers
• Thinking Markdown is unsupported in Postman
• Using wrong asterisks count for bold

5. You want to add a clickable link in your Postman description that says API Docs and points to https://docs.example.com. Which Markdown syntax is correct?

hard

A. "API Docs":https://docs.example.com

B. API Docs

C. [API Docs](https://docs.example.com)

D. {API Docs}(https://docs.example.com)

Solution

1. Step 1: Recall Markdown link syntax

   Markdown links use [text](url) format to create clickable links.

2. Step 2: Evaluate options

   [API Docs](https://docs.example.com) uses correct Markdown syntax. API Docs is HTML, which may work but is not Markdown. The remaining options are invalid Markdown.

3. Final Answer:

   [API Docs](https://docs.example.com) -> Option C

4. Quick Check:

   Links = [text](url) [OK]

Hint: Use [text](url) for links [OK]

Common Mistakes:

• Using HTML tags instead of Markdown
• Wrong bracket types for links
• Confusing quotes with brackets