Wednesday, April 13, 2016

RestAPI Docs using apidocjs during build on Jenkins

* Installation - npm install apidoc -g

* Sample Documentation done for a Distcp(Hadoop File System) utility method is shown below

* Create a file called apidoc.json with following content

* Now in Jenkins  

* Now from the browser go to the workspace of this Project in Jenkins and see docs folder and point to index.html, you can see following icon
* Left side of the page will have 

* On Right side of the page shows actual documentation

* One can get more detailed examples at


No comments:

Post a Comment