@sayanriju/apidoc2postman

1.1.7 • Public • Published

A simple NPM cli/bin package to generate Postman Collection scaffolds from Apidoc documentations.

Usage

  • cd into a documentation folder generated by the apidoc application. By default, such folders are named docs/ and contain the files api_data.json & api_project.json among others.

  • Run the command npx @sayanriju/apidoc2postman inside the folder. It will write a JSON text to STDOUT, which may be written to a file using the shell's piping mechanism, like so:

    npx @sayanriju/apidoc2postman > ~/myProject.postman_collection.json

  • The ~/myProject.postman_collection.json file may now be imported into Postman as usual. Note that, the imported Postman Collection is just a skeleton/scaffold and as such will need to be heavily edited/fine-tuned.

Package Sidebar

Install

npm i @sayanriju/apidoc2postman

Weekly Downloads

0

Version

1.1.7

License

MIT

Unpacked Size

7.58 kB

Total Files

5

Last publish

Collaborators

  • sayanriju