postmanreadmegen

1.1.0 • Public • Published

PostmanReadmeGen

PostmanReadmeGen is a tool that generates documentation from Postman collections into README files. It creates two sections within the README:

  1. Summary: A concise summary of the Postman collection.
  2. Detailed: This section includes detailed information from the collection.

Installation

To get started, import generateTrees and provide a folder with your Postman collections.

import { generateTrees } from 'postmanreadmegen';
generateTrees('collection');

Then simply run node yourfile.js.

Contributing

Contributions are welcome. Feel free to open an issue or submit a pull request.

License

This project is licensed under the MIT License, which you can read in the LICENSE file.

Author

  • Author: Siarhei Zavadski

/postmanreadmegen/

    Package Sidebar

    Install

    npm i postmanreadmegen

    Weekly Downloads

    2

    Version

    1.1.0

    License

    MIT

    Unpacked Size

    9.55 kB

    Total Files

    10

    Last publish

    Collaborators

    • siarhei-zavadski