Custom documentation templates in Postman

Introduction

Custom documentation templates help you create clear and easy-to-understand API docs that fit your team's style. This makes sharing and using APIs simpler for everyone.

You want to add your company logo and colors to API docs.

You need to explain API endpoints with extra examples or notes.

You want to hide some technical details to keep docs simple.

You want to organize API info in a way that matches your workflow.

You want to create docs that non-technical people can understand.

Syntax

Postman

Handlebars template syntax is used for custom docs in Postman.

Example placeholders:
{{title}} - API title
{{description}} - API description
{{#each endpoints}} ... {{/each}} - Loop through endpoints
{{method}} - HTTP method
{{url}} - Endpoint URL
{{response}} - Example response

Use double curly braces {{}} to insert variables.

Use #each to loop through lists like endpoints.

Examples

Shows the API title and description in the docs.

Postman

{{title}}

{{description}}

Lists all API endpoints with their method, URL, and description.

Postman

{{#each endpoints}}
- {{method}} {{url}}: {{description}}
{{/each}}

Shows each endpoint with an example response.

Postman

{{#each endpoints}}
### {{method}} {{url}}
Example response:
{{response}}
{{/each}}

Sample Program

This template creates a simple API documentation page. It shows the API title and description, then lists each endpoint with its method, URL, description, and example request and response.

Postman

/* Sample Postman custom documentation template using Handlebars */

{{title}}

{{description}}

## Endpoints

{{#each endpoints}}
### {{method}} {{url}}
Description: {{description}}

Example Request:
```
{{method}} {{url}}
```

Example Response:
```
{{response}}
```

{{/each}}

Important Notes

Test your template with sample data to see how the docs look.

Keep templates simple for easy updates and maintenance.

You can use HTML inside templates for better formatting.

Summary

Custom documentation templates let you control how API docs look and feel.

They use Handlebars syntax with placeholders and loops.

Templates help make docs clearer and fit your team's needs.