SDK generator examples | Postman Docs

The Postman SDK Generator transforms your Postman Collections into client SDKs for nine programming languages. Generate type-safe client libraries with automatic method generation, intelligent type inference, and comprehensive documentation directly from your API specifications. These examples show practical implementation patterns, customization techniques, and advanced use cases to help you build production-ready SDKs with preserved custom code.

Basic SDK generation

Learn the fundamentals of generating SDKs from Postman Collections and API specifications:

Setting up the CLI environment — Install and configure the Postman CLI
Running your first SDK generation — Generate your first SDK from a collection
Understanding the generated code structure — Learn how to use and integrate generated SDKs
Basic configuration options — Configure SDK generation settings

Custom code integration

Add custom logic, validation, and utilities while maintaining changes through regenerations:

Generate an SDK with custom code — Add custom logic, validation, and utilities while maintaining changes through regenerations

Best practices

To get the most out of the Postman SDK generator, follow these best practices when designing your API collections and configuring your SDK generation:

Use descriptive names for requests and folders
Add comprehensive examples with realistic data
Include detailed descriptions for auto-generated documentation
Organize endpoints into logical service groups

To maintain custom code across regenerations, follow these guidelines:

Keep custom code focused and well-documented
Use consistent patterns across service modules
Implement proper error handling for edge cases
Add logging for debugging and monitoring

To manage SDK versions and updates effectively, consider the following strategies:

Tag collection versions before major SDK updates
Test SDK regeneration in development environments
Maintain backwards compatibility when possible
Document breaking changes and migration guides