Description formatting (Markdown) in Postman - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is Markdown in Postman descriptions?

Markdown is a simple way to format text using plain characters. In Postman, it helps make descriptions clear and easy to read by adding styles like bold, italics, lists, and links.

beginner

How do you make text bold in Postman descriptions using Markdown?

To make text bold, wrap it with double asterisks **like this** or double underscores __like this__.

beginner

How can you add a numbered list in Postman description using Markdown?

Start each line with a number followed by a dot and a space, like: 1. First item 2. Second item 3. Third item

beginner

What is the Markdown syntax for adding a hyperlink in Postman descriptions?

Use square brackets for the link text and parentheses for the URL: [Link text](https://example.com).

beginner

Why use Markdown formatting in Postman descriptions?

Markdown makes descriptions easier to read and understand by adding structure and style. It helps testers and developers quickly grasp important details without confusion.

Which Markdown syntax makes text italic in Postman descriptions?

A *italic*

B **italic**

C ~~italic~~

D `italic`

Single asterisks * or underscores _ around text make it italic in Markdown.

How do you create a bullet list in Postman Markdown?

A Use dashes (-) or asterisks (*) at the start of lines

B Use plus signs (+) only

C Use angle brackets <>

D Use numbers like 1., 2., 3.

Bullet lists use dashes (-) or asterisks (*) at the start of each line.

What is the correct way to add a link in Postman Markdown?

A (Example)[https://example.com]

B [https://example.com]

C <https://example.com>

D [Example](https://example.com)

Markdown links use [text](URL) format.

Which symbol is NOT used in Markdown for formatting text?

A *

B #

C $

D `

The dollar sign ($) is not used for Markdown formatting.

Why is Markdown preferred for Postman descriptions?

A It allows adding images only

B It formats text simply and clearly

C It makes text colorful

D It encrypts the description

Markdown helps format text simply and clearly for better readability.

Explain how to format a description in Postman using Markdown to include bold text, a bullet list, and a hyperlink.

Think about simple symbols that add style and structure.

Why is it important to use Markdown formatting in Postman descriptions when sharing tests with your team?

Consider how clear communication helps teamwork.

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