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.