No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.idea
classes
formatters
global
helpers
templates/apidoc
main.js
package.json
readme.md

readme.md

Installation

npm install docmaster -g

Usage

Steps to create documentation with Postman and docmaster

1) Prepare collection in Postman

2) Save success and error responses for every request in Postman collection

3) Save Postman collection

4) Use docmaster package to create Apidoc documentation

Exporting Postman collection to Apidoc format

docmaster -i postmanDump.json -o ./exportFolder

apidoc -i ./exportFolder/collectionName -o ./documentation

Exporting Postman collection to Apidoc format & creating Apidoc documentation

docmaster -i postmanDump.json -o ./exportFolder -apidocCollection myApi -apidocOutput localhost/apidocDocumentationFolder

Description

Docmaster exports Postman collection to Apidoc format ( Apidoc npm package ).