Custom documentation templates in Postman - Framework Patterns

Framework Mode - Custom documentation templates

Folder Structure for Postman Custom Documentation Templates

postman-project/
├── collections/
│   └── api-collection.json       # Your Postman API collection
├── environments/
│   └── dev.postman_environment.json
├── documentation-templates/
│   ├── custom-template.hbs       # Handlebars template for docs
│   └── assets/
│       ├── css/
│       └── images/
├── scripts/
│   └── generate-docs.js          # Script to generate docs using template
├── config/
│   └── config.json               # Config for environments, output paths
└── README.md

Test Framework Layers for Postman Custom Documentation Templates

• Collections Layer: Contains Postman API collections (.json) defining requests and tests.
• Template Layer: Custom Handlebars (.hbs) templates to format documentation output.
• Script Layer: Node.js scripts that load collections and templates, then generate HTML docs.
• Config Layer: JSON files to manage environment variables, output directories, and template options.
• Assets Layer: CSS and images used by documentation templates for styling and branding.

Configuration Patterns

• Environment Config: Use separate Postman environment files for different API environments (dev, staging, prod).
• Template Config: Store template options (like theme, logo path) in a JSON config file to keep scripts flexible.
• Output Paths: Define output folder paths in config to organize generated documentation versions.
• Script Parameters: Pass environment and template choices as command-line arguments to the generation script.

Test Reporting and CI/CD Integration

• Documentation Generation: Automate docs generation in CI pipelines using scripts that run on collection updates.
• Version Control: Store templates and scripts in Git to track changes and enable collaboration.
• Publish Docs: Upload generated HTML docs to a web server or documentation portal automatically after CI build.
• Validation: Include checks in CI to ensure collections and templates are valid before generating docs.

Best Practices for Custom Documentation Templates in Postman

• Keep Templates Simple: Use clear, readable Handlebars templates to make maintenance easy.
• Separate Content and Style: Use CSS files for styling, keep templates focused on structure and data.
• Use Versioning: Version your templates and collections to track changes and rollback if needed.
• Automate Generation: Integrate docs generation into CI to keep docs always up-to-date.
• Test Templates: Preview generated docs locally to catch formatting issues early.

Self Check

Where in this folder structure would you add a new CSS file to change the look of your documentation?

Key Result

Organize Postman collections, custom Handlebars templates, and generation scripts with clear config and assets folders for automated, maintainable API documentation.

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}}