Add and serve apiDoc documentation (for Tags)

[xvjg]

Github: apiDoc

• Add a package.json script docs which will generate the documentation into a folder, docs/
• Serve the docs in express at route /api/docs
• Document Tag route first, then we can decide how to document the whole project.

Documentation can include the following annotations:

• @api for method, route, and 1 line description
• @apiName for naming a route (GetTagList, GetTagBySlug)
• @apiDescription, if required, for special routes or special notes.
• @apiGroup for each resource (Tag)
• @apiParam for the fields which can be passed in body or filter.
• @apiPermission, first use @apiDefine in auth middleware to define the user permission model, then use that in authRequired routes.
• @apiSuccessto define the fields in response document.

Avoid @apiError and @apiHeader for now.

[YJDoc2]

Api Doc generates a handlebars template which is supposed to be dynamically filled in at client side by script tag functions, but they are blocked by CSP policies of browsers.That's why we cannot directly serve the Docs generated by apidoc from express.Should we try to change to another doc generating library?

[xvjg]

apidoc generates HTML/CSS/JS tho, not handlebars

[YJDoc2]

The issue was with helmet middleware CSP used,fixed it.

[YJDoc2]

Complete Page

NOTE : The side-bar, in actual page is sticky, and stays always on side for all time

Page as visible in window :

[YJDoc2]

Also added jsDoc documentation for documenting backend code(currently Tags only).

Documentation :

It can also show the files being documented :