postman-documentor
v1.0.2
A package that converts Postman API collection v2.1 into a proper documentated PDF file
0/weekUpdated 3 years agoISCUnpacked: 161.1 KB
Published by Prabhjot Singh
npm install postman-documentorWelcome to postman-documentor š
> A package that converts Postman API collection v2.1 into a proper documentated PDF file.
> This package assumes you have collection with sub folders at only root level.
> For ex: Collection quiz contains 3 sub collection folders Students, Parents and Teacher.
Install
``sh`
npm i postman-documentor
Usage
`sh
var documentor=require("postman-documentor");
let filepath="collection.json";
documentor(filepath);
`
Output
>Output filename will be generated in a folder name "output" and filename will be documentation.pdf.
Run tests
`sh``
npm run test
Author
š¤ Prabhjot Singh
* Github: @prab409069
Show your support
Give a āļø if this project helped you!
š License
Copyright Ā© 2020 Prabhjot Singh.
This project is ISC licensed.