0.1.0 β’ Published 1 month ago
@sirhc77/postman-sdk-gen v0.1.0
Postman TypeScript SDK Generator
Generate a fully-typed TypeScript SDK from a Postman collection, with support for Axios or Fetch, folder-based namespacing, and auto-inferred types.
β¨ Features
- π Input: Supports Postman Collection v2.1
- π¦ Output: TypeScript SDK with methods, namespaces, and inferred request/response types
- β‘ Transport: Axios (default) or Fetch
- π Authentication: Auto-parses Postman auth schemes (Bearer, API Key, Basic Auth)
- π§ Type Inference: Generates interfaces for bodies and responses
- ποΈ Folder-Based Namespacing: Postman folders become nested namespaces
- π§Ύ .d.ts Generation: Optional separate type declarations for consumption in JS projects
π Getting Started
1. Install
npm install -g @sirhc77/postman-sdk-gen
2. Generate SDK
postman-sdk-gen ./collection.json \
--output ./sdk \
--client-name ApiClient \
--use-fetch \
CLI Options
Flag | Description |
---|---|
--output | Output directory (default: ./sdk ) |
--client-name | Name of generated class (default: ApiClient ) |
--use-fetch | Use native fetch instead of Axios |
--single-file | Generate one file instead of multi-file |
--quiet | Supress logs |
--version | Show version |
π§ͺ Sample Usage
import { ApiClient } from './sdk/ApiClient';
const client = new ApiClient('https://api.example.com', '<your username>', '<your password>');
const res = await client.users.getCurrentUser();
π Namespacing
A Postman folder structure like:
- Space Management
- Phone Numbers
- List All
β¦generates:
client.spaceManagement.phoneNumbers.listAll();
π Authentication
Postman auth
sections are auto-detected. Supported:
- Bearer token`
- API key
- Basic Auth
π οΈ Contributing
- Clone the repo
- Run locally with
ts-node
or build withtsc
- Use
examples/*.postman_collection.json
to test
π License
MIT License
0.1.0
1 month ago