Cacher is the code snippet organizer for pro developers

CLI

apidoc -f ".*\\.js$" -i apisrc/ -o apidoc/

apidoc.json

{
  "name": "API Document",
  "version": "0.1.0",
  "description": "API Document for website development.",
  "apidoc": {
    "title": "API Document"
  },
  "template": {
    "forceLanguage": "en"
  }
}

Example

/**
 * @api {post} /member Add Member
 * @apiVersion 0.2.2
 * @apiName Add Member
 * @apiGroup Member
 * @apiPermission Admin
 *
 * @apiParam {String} account User Account
 * @apiParam {String} name User Name
 * @apiParam {String} email User Mail
 * @apiParamExample {json} Request
 *      {
 *          account: "johndoe",
 *          name: "johndoe",
 *          email: "johndoe@anonymous.org"
 *      }
 * @apiSuccess {Bool} success Result
 * @apiSuccessExample {json} Request
 *      {
 *          success: true
 *      }
 * @apiError {Bool} success Result
 * @apiErrorExample {json} Response
 *      {
 *          success: false
 *      }
 */