Skip to content

bonzzy/docmaster

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

54 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 ).

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published