do-postmark v1.0.2
PostMark
A small Node.js program to convert Postman collections to Markdown friendly syntax. PostMark takes a collection of API routes from Postman and converts it into Markdown friendly syntax ready to be added to a GitHub README.md file. For our first stage we are using GitHub Flavored Markdown, hopefully adding others if time permits.
Since documentation is incredibly important when hosting a project on GitHub we believe that this will help developers very easily show the routes used in their APIs. This should save the developer time, make using a project easier for users and improve readability of documentation.
We hope to make PostMark an installable NodeJS package and eventually a serverless function that any user can pass a JSON-based Postman collection to and recieve back Markdown syntax.
Problem Domain : Auto-generating documentation for JSON.
App takes JSON file as input and outputs the documentation template in .md format.
Why behind the project:
- Manual process is repetitive
- It is also error prone
- Not a motivating or creative task!
What problems it solves:
- Eliminates painstaking manual process
- Minimizes errors in manual copying
Whiteboard/UML
Requirements
Resources/Links
Node.js
Markdown Features in GitHub
Postman V2.1 Collection Schema
NPM Publish
Authors
Andre Olivier Martin - @Doktor-Doom
Jeremy Penning - @pixeljava
Sowmya Billakanti - @SowmyaBillakanti
Tahmina Ringer - @tahminaringer