https://github.com/mrniamster/postman-collection-ts
Generate Types for your API Made Easy!! - Supports Postman Collections
https://github.com/mrniamster/postman-collection-ts
api generate postman postman-collection types typescript
Last synced: 5 months ago
JSON representation
Generate Types for your API Made Easy!! - Supports Postman Collections
- Host: GitHub
- URL: https://github.com/mrniamster/postman-collection-ts
- Owner: mrniamster
- Created: 2023-08-06T08:31:20.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-25T03:10:22.000Z (almost 2 years ago)
- Last Synced: 2025-09-19T16:51:14.582Z (9 months ago)
- Topics: api, generate, postman, postman-collection, types, typescript
- Language: Jupyter Notebook
- Homepage:
- Size: 32.2 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: ReadMe.md
Awesome Lists containing this project
README
# Introduction
We all always want to access the properties for our api response,Imagine Creating Types for API, You will usually head over to tool or create on your self if the API list is few, 😌 Imagine the List is 500 Now ? How Many hours are your ready to spend, to Speed this up, Presenting POSTMAN-API-TYPES Generator ⚙️ which will automate this for you in just few seconds.
> Contribution's are Appericiated, This is Open Source - lets Build it Awesome 🥳
# Features
- Generate Types from PostMan Collection URL.
- Generate Types from exported PostMan Collection JSON locally.
# Installation
- git clone https://github.com/mrniamster/postman-collection-ts
- npm install
# Usage
## Local Generation
- Export the Postman collaction JSON
- Paste the content inside data.json
- Run ``` node index.js ```
## PostMan Collecion Generation
- Right Click your Collection on Postman
- Click on Share
- Select "Via Api"
- Copy the Collection Link , Format should be like this (https://api.postman.com/collections/14847620-56888139-d2e7-46e0-8b2a-7e77ce040607?access_key=``)
- Run ``` node index.js -c https://api.postman.com/collections/14847620-56888139-d2e7-46e0-8b2a-7e77ce040607?access_key=```
> The Types will be generated inside Types directory
# RoadMap
- [ ] GENERAL - Convert js to TS
- [x] POSTMAN - Fetch JSON from Collection POSTMAN URL
- [ ] GENERAL - Create Custom CMD for Postman / Normal JSON