postman-documentor

Welcome 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

npm i postman-documentor

Usage

    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

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.