A simple NPM cli/bin package to generate Postman Collection scaffolds from Apidoc documentations.
-
cd
into a documentation folder generated by theapidoc
application. By default, such folders are nameddocs/
and contain the filesapi_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.