Custom documentation templates in Postman - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to set a custom documentation template in Postman.

Postman

pm.documentation.setTemplate([1]);

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

AsetTemplate

BcustomTemplate.html

C'customTemplate.html'

Dtemplate

Attempts:

3 left

💡 Hint

Common Mistakes

Forgetting to put quotes around the template file name.

Passing a variable name without defining it.

You need to pass the template file name as a string to setTemplate. So, it must be in quotes.

2fill in blank

medium

Complete the code to add a variable to the documentation template context.

Postman

pm.documentation.addVariable([1], 'API Version');

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

A'version'

Bversion

CapiVersion

D'apiVersion'

Attempts:

3 left

💡 Hint

Common Mistakes

Using unquoted variable names which may cause errors.

Using a wrong variable name.

The variable name passed to addVariable must be a string. So, it must be in quotes.

3fill in blank

hard

Fix the error in the code to correctly set the documentation template.

Postman

pm.documentation.[1]('customTemplate.html');

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

AtemplateSet

Bsettemplate

Cset_doc_template

DsetTemplate

Attempts:

3 left

💡 Hint

Common Mistakes

Using incorrect casing in method names.

Using method names that do not exist.

The correct method name is setTemplate with capital T.

4fill in blank

hard

Fill both blanks to add title and description variables for the documentation template.

Postman

pm.documentation.addVariable([1], 'My API'); pm.documentation.addVariable([2], 'This API handles requests.');

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

A'title'

B'desc'

C'description'

D'summary'

Attempts:

3 left

💡 Hint

Common Mistakes

Using variable names that do not match the template placeholders.

Forgetting quotes around variable names.

The variable names should be 'title' and 'description' to match the template placeholders.

5fill in blank

hard

Fill all three blanks to define a custom template with placeholders for name, version, and description.

Postman

const template = `<h1>[1]</h1><p>Version: [2]</p><p>[3]</p>`;

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

Aname

Bversion

Cdescription

Dtitle

Attempts:

3 left

💡 Hint

Common Mistakes

Mixing up placeholder names.

Using keys not defined in the context.

The placeholders in the template should be 'title', 'version', and 'description' to display the correct information.

Practice

1. What is the main purpose of custom documentation templates in Postman?

easy

A. To control the appearance and structure of API documentation

B. To write test scripts for API requests

C. To automate API request execution

D. To generate API mock servers

Solution

1. Step 1: Understand the role of documentation templates

   Custom documentation templates let you change how API docs look and feel, making them clearer and tailored.

2. Step 2: Differentiate from other Postman features

   Test scripts, automation, and mock servers serve different purposes unrelated to documentation appearance.

3. Final Answer:

   To control the appearance and structure of API documentation -> Option A

4. Quick Check:

   Custom templates = control doc look [OK]

Hint: Templates change docs look, not tests or mocks [OK]

Common Mistakes:

• Confusing templates with test scripts
• Thinking templates automate requests
• Mixing templates with mock server setup

2. Which syntax is used inside Postman custom documentation templates to insert dynamic content?

easy

A. [[variable]]

B. {{variable}}

C. %%variable%%

D. ##variable##

Solution

1. Step 1: Identify the templating syntax used by Postman

   Postman uses Handlebars syntax, which uses double curly braces like {{variable}} to insert dynamic content.

2. Step 2: Compare with other common syntaxes

   Other options like [[ ]], %% %% or ## ## are not used in Postman templates.

3. Final Answer:

   {{variable}} -> Option B

4. Quick Check:

   Handlebars = {{variable}} [OK]

Hint: Remember Handlebars uses double curly braces {{}} [OK]

Common Mistakes:

• Using square brackets instead of curly braces
• Confusing with environment variable syntax
• Using percent signs or hashes incorrectly

3. Given this snippet in a Postman custom documentation template:

{{#each requests}}
- {{name}}
{{/each}}

What will this code output?

medium

A. The word 'requests' repeated multiple times

B. An error because loops are not allowed

C. A list of request names from the collection

D. Nothing, because {{name}} is undefined

Solution

1. Step 1: Understand the Handlebars loop syntax

   The {{#each requests}} block loops over all requests in the collection, outputting each request's name.

2. Step 2: Determine the output of the loop

   Each iteration outputs a dash and the request name, creating a list of request names.

3. Final Answer:

   A list of request names from the collection -> Option C

4. Quick Check:

   Loop over requests outputs names [OK]

Hint: Loops with #each output list items [OK]

Common Mistakes:

• Thinking loops are not supported
• Assuming {{name}} is undefined
• Expecting repeated static text instead of dynamic names

4. You wrote this in a Postman custom documentation template:

{{#each requests}}
- {{name}
{{/each}}

Why does the documentation fail to render correctly?

medium

A. Incorrect loop syntax, should be {{#for requests}}

B. The closing tag {{/each}} is missing

C. The variable 'name' does not exist in requests

D. Missing closing curly brace in {{name}}

Solution

1. Step 1: Check the variable syntax inside the loop

   The variable {{name} is missing a closing curly brace, it should be {{name}}.

2. Step 2: Verify loop syntax and tags

   The loop uses correct {{#each requests}} and closing {{/each}} tags, so those are not the issue.

3. Final Answer:

   Missing closing curly brace in {{name}} -> Option D

4. Quick Check:

   All must have matching braces [OK]

Hint: Check all {{}} pairs are closed properly [OK]

Common Mistakes:

• Using wrong loop syntax like #for
• Assuming variable 'name' is missing
• Forgetting to close the loop tag

5. You want to create a custom documentation template that shows each request's name and description only if the description exists. Which Handlebars syntax correctly achieves this?

hard

A. {{#each requests}}
- {{name}}
{{#if description}}
Description: {{description}}
{{/if}}
{{/each}}

B. {{#each requests}}
- {{name}}
{{#unless description}}
Description: {{description}}
{{/unless}}
{{/each}}

C. {{#each requests}}
- {{name}}
{{#if !description}}
Description: {{description}}
{{/if}}
{{/each}}

D. {{#each requests}}
- {{name}}
{{#exists description}}
Description: {{description}}
{{/exists}}
{{/each}}

Solution

1. Step 1: Use the correct conditional block for existence

   Handlebars uses {{#if variable}} to check if a variable exists and is truthy.

2. Step 2: Verify the loop and conditional structure

   {{#each requests}}
   - {{name}}
   {{#if description}}
     Description: {{description}}
   {{/if}}
   {{/each}}

   correctly loops over requests, shows name, and conditionally shows description only if it exists.

3. Final Answer:

   {{#each requests}} - {{name}} {{#if description}} Description: {{description}} {{/if}} {{/each}} -> Option A

4. Quick Check:

   Use {{#if}} to check existence [OK]

Hint: Use {{#if variable}} to show content only if it exists [OK]

Common Mistakes:

• Using {{#unless}} which shows content when variable is missing
• Trying to negate with ! inside {{#if}} which is invalid
• Using non-existent helpers like {{#exists}}