apidoc and swagger are two nice projects which are focusing on documentation of APIs. This project is a middle tier which tries to bring them together in a sense that:
It uses apidoc to convert inline documentation comments into json schema and later convert it to swagger json schmea.
Uses the apidoc-core library.
How It Works
swagger.json file which can be served to swagger-ui to generate html overview of documentation.
/*** @api* @apiName GetUser* @apiGroup User** @apiParam** @apiSuccess* @apiSuccess*/
npm install apidoc-swagger -g
Current version unlocks most of the basic capabilities of both projects and improvement is in progress.
apidoc-swagger -i example/ -o doc/
Have a look at apidoc for full functionality overview and capabilities of apidoc.
npm install gulp-apidoc-swagger.