{"_id":"express-rest-help","_rev":"28-9ac66c0eda85480b6901904c485ee327","name":"express-rest-help","dist-tags":{"latest":"0.5.0"},"versions":{"0.0.1":{"name":"express-rest-help","version":"0.0.1","private":false,"scripts":{"start":"node app.js"},"dependencies":{"express":"3.4.8","jade":"*","mocha":"~1.17.1","supertest":"~0.9.0"},"main":"routes/Help.js","directories":{"test":"test"},"devDependencies":{"mocha":"~1.17.1"},"repository":{"type":"git","url":"git@bitbucket.org:vgtf/teg-express-route-help.git"},"keywords":["express","rest","help","helptool","restdoc","docs"],"author":{"name":"Greg Jones","email":"gregory.jones05@gmail.com","url":"http://news.google.com/"},"license":"ISC","_id":"express-rest-help@0.0.1","dist":{"shasum":"7a8dad6a1fe97bf4cf8ee2ecf084a4c855085102","tarball":"https://registry.npmjs.org/express-rest-help/-/express-rest-help-0.0.1.tgz","integrity":"sha512-ClZpGUkqaBvM0qEmY73NZoDFv47+OzWcT6mQ/w6Ttsou12auOBPjnuAbU6uzhkaEXFSN8K0xjA/oIg32VAX7lg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICjQUF7xVYeIvmygmYn2NXoZ9tvQtRx7o9kP9OcHMjt7AiEAidqo/P7rcyg2HLHIhuaW9NH5Pczj+afsHSl2j4JOd8Q="}]},"_from":"./","_npmVersion":"1.3.21","_npmUser":{"name":"gjones","email":"gregory.jones@turner.com"},"maintainers":[{"name":"gjones","email":"gregory.jones@turner.com"}]},"0.0.2":{"name":"express-rest-help","version":"0.0.2","private":false,"scripts":{"start":"node app.js"},"dependencies":{"express":"3.4.8","jade":"*","mocha":"~1.17.1","supertest":"~0.9.0"},"_id":"express-rest-help@0.0.2","dist":{"shasum":"0e3898b04cea617e631ae3ea9ace7aa6487f08d3","tarball":"https://registry.npmjs.org/express-rest-help/-/express-rest-help-0.0.2.tgz","integrity":"sha512-HTDBRCOStOiLwEqix4vdbHgDIaqUQBnRC4B3TWmRdFoljLZ4plW8Sv0DBjyyLdZ/fo5ZxGHq6pnCcCp6LR93Rw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC0+aufXoGoTtC5wBc7XMd7l8XNX4g0+PuI33a+BCiXwgIgd7z/QCDsg/AFKj5rG1uENmqOrDCJC8thIswaXCErHm0="}]},"_from":"./","_npmVersion":"1.3.24","_npmUser":{"name":"gjones","email":"foo@home.com"},"maintainers":[{"name":"gjones","email":"gregory.jones@turner.com"}]},"0.0.3":{"name":"express-rest-help","version":"0.0.3","scripts":{"start":"node app.js"},"dependencies":{"express":"3.4.7","jade":"*"},"main":"routes/Help.js","keywords":["express-rest-help","rest","help","restdocs","express","help","module"],"author":{"name":"Greg Jones","email":"gregory.jones@turner.com","url":"http://none/"},"license":"ISC","_id":"express-rest-help@0.0.3","dist":{"shasum":"6d0d4fcc1313412b9a3e606e5c042a9b0c4d7df8","tarball":"https://registry.npmjs.org/express-rest-help/-/express-rest-help-0.0.3.tgz","integrity":"sha512-cRdfoSms9k/RT5MdNw7evTGZUFWASXTY76bqWBL08WDGnuXXXT/GnWvLu8lWaF073ktGoaEUiEBgf+SfkBk9FA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCID6xcWmaQhXDbu4nuxByuhli602CKCfJn72PvoKrtf7RAiB0350A0GbUONwKGghOT4x3zzjHyqXa6UIzXwbuiQoNyA=="}]},"_from":"./","_npmVersion":"1.3.24","_npmUser":{"name":"gjones","email":"foo@home.com"},"maintainers":[{"name":"gjones","email":"gregory.jones@turner.com"}]},"0.0.4":{"name":"express-rest-help","version":"0.0.4","private":false,"scripts":{"start":"node routes/Help.js"},"dependencies":{"express":"3.4.8","jade":"*","mocha":"~1.17.1","supertest":"~0.9.0"},"_id":"express-rest-help@0.0.4","dist":{"shasum":"8487bdf3274714890d3f5a147c2b1cc33649a411","tarball":"https://registry.npmjs.org/express-rest-help/-/express-rest-help-0.0.4.tgz","integrity":"sha512-iHJeEWQ4CiFQNBW0AizTOA6ieAF9DrcOYexhY+4NEIIC8l9veZWbJqOb0wwYZseSWtXd9nz86YPWUfN3/c52Tg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIASVhmMwhxCO7ZRNakBz9oZTjoA4cc8TDgm8/BZZqALqAiEAvZHbNkX3KS5gnFSnYUvQ3Oli2pr2J5+fQLvlzBSwjQo="}]},"_from":"./","_npmVersion":"1.3.24","_npmUser":{"name":"gjones","email":"foo@home.com"},"maintainers":[{"name":"gjones","email":"gregory.jones@turner.com"}]},"0.0.5":{"name":"express-rest-help","version":"0.0.5","private":false,"scripts":{"start":"node routes/Help.js"},"dependencies":{"express":"3.4.8","jade":"*","mocha":"~1.17.1","supertest":"~0.9.0"},"main":"routes/Help.js","directories":{"test":"test"},"devDependencies":{"mocha":"~1.17.1"},"repository":{"type":"git","url":"git@bitbucket.org:vgtf/teg-express-rest-help.git"},"keywords":["rest","help","express","rest","help","routedocs","route","help"],"author":{"name":"Greg Jones","email":"gregory.jones@turner.com","url":"http://none/"},"license":"ISC","_id":"express-rest-help@0.0.5","dist":{"shasum":"40183bc382d3581a0f0901782b3f78a240e6eb2a","tarball":"https://registry.npmjs.org/express-rest-help/-/express-rest-help-0.0.5.tgz","integrity":"sha512-+x8dme08y0aphqejR9Npzc018OLsMulXN8aKkardfBBP7mOEnbzPTGXmnrLcsr2Kvwb4G9/EZsvNHYPpbuJjDA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDZPYBvIpm1O99xkwTB3bicBkIDD96HDtPtwrT9uOQ0FQIhALAIFn1bcjYvtozB1kSDyIXhvfet7lc2uyhDfGBg64Uv"}]},"_from":"./","_npmVersion":"1.3.24","_npmUser":{"name":"gjones","email":"foo@home.com"},"maintainers":[{"name":"gjones","email":"gregory.jones@turner.com"}]},"0.0.6":{"name":"express-rest-help","version":"0.0.6","private":false,"scripts":{"start":"node routes/Help.js"},"dependencies":{"express":"3.4.8","jade":"*","mocha":"~1.17.1","supertest":"~0.9.0"},"main":"routes/Help.js","directories":{"test":"test"},"devDependencies":{"mocha":"~1.17.1"},"repository":{"type":"git","url":"git@bitbucket.org:vgtf/teg-express-rest-help.git"},"keywords":["rest","help","express","rest","help","routedocs","route","help"],"author":{"name":"Greg Jones","email":"gregory.jones@turner.com","url":"http://none/"},"license":"ISC","_id":"express-rest-help@0.0.6","dist":{"shasum":"4281dfe2ae46fbefb20d128e32e3f676de0cb916","tarball":"https://registry.npmjs.org/express-rest-help/-/express-rest-help-0.0.6.tgz","integrity":"sha512-fiXWIgVEOCf9nqbUW2Z6Ykum13r5Y3L9pfnhNrACC4eoDK2PkyPf43rL8RARwegpiZiXvToWy1FV8L0GZqjWDQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDDTCvfjayBPbQU1R7Vfue6N8kQaZd7EtKrjkjKQeq3BAIgNPxNFHeLEblsNsP1SJn73rihLf9biRd6zVDlCd8rJck="}]},"_from":"./","_npmVersion":"1.3.24","_npmUser":{"name":"gjones","email":"foo@home.com"},"maintainers":[{"name":"gjones","email":"gregory.jones@turner.com"}]},"0.0.7":{"name":"express-rest-help","version":"0.0.7","private":false,"scripts":{"start":"node routes/Help.js"},"dependencies":{"express":"3.4.8","jade":"*","mocha":"~1.17.1","supertest":"~0.9.0"},"main":"routes/Help.js","directories":{"test":"test"},"devDependencies":{"mocha":"~1.17.1"},"repository":{"type":"git","url":"git@bitbucket.org:vgtf/teg-express-rest-help.git"},"keywords":["rest","help","express","rest","help","routedocs","route","help"],"author":{"name":"Greg Jones","email":"gregory.jones@turner.com","url":"http://none/"},"license":"ISC","description":"express-rest-help ============== This module renders pretty (Twitter Bootstrap styled) help topics for each RESTful path in your Express app. This is an easy way to provide documentation for your Nodejs Express REST API/APP.","_id":"express-rest-help@0.0.7","dist":{"shasum":"e3a425b490d1486f096c1c15f5f999f880ee8d56","tarball":"https://registry.npmjs.org/express-rest-help/-/express-rest-help-0.0.7.tgz","integrity":"sha512-eW8R1+tRDq0Gz3hNxKOJ1l9ZBvp8WxKbmCFBs0cfLxDETdgvcrPdt2y0lrtMxiAEwSmNkTZOzUw1VPvup7+CyQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIC3zQRpV9uWes1Sr+nrlKBn91EUkRB2t6mXqtwDGTC+BAiEAxmJw7g9/I38IoWSCS1t0Ev3aDxU2XNk0bVnkJMiISZ8="}]},"_from":"./","_npmVersion":"1.3.24","_npmUser":{"name":"gjones","email":"foo@home.com"},"maintainers":[{"name":"gjones","email":"gregory.jones@turner.com"}]},"0.1.0":{"name":"express-rest-help","version":"0.1.0","private":false,"scripts":{"start":"node routes/Help.js"},"dependencies":{"express":"3.4.8","jade":"*","mocha":"~1.17.1","supertest":"~0.9.0"},"main":"routes/Help.js","directories":{"test":"test"},"devDependencies":{"mocha":"~1.17.1"},"repository":{"type":"git","url":"git@bitbucket.org:vgtf/teg-express-rest-help.git"},"keywords":["rest","help","express","rest","help","routedocs","route","help"],"author":{"name":"Greg Jones","email":"gregory.jones@turner.com","url":"http://none/"},"license":"ISC","description":"express-rest-help =================","_id":"express-rest-help@0.1.0","dist":{"shasum":"eaeba5a12162e3fe031f3993e1f9cdf839d96eb7","tarball":"https://registry.npmjs.org/express-rest-help/-/express-rest-help-0.1.0.tgz","integrity":"sha512-GQCRWsZLyrC9vtL4LlV6F2V7jDudGIO+GLk2HY6xry9aqU09EqVHq90ueqTSrDWf17p160lJbmGf8JPBvEcviw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDKtkvjFEiXlYW0R5ohC+GnXJ7DjtDBrDcadwS/gCUycwIhAImM5ytSOjhRrGZLmn2q/7hGE3Dckc3eO/oH4e4lBbOq"}]},"_from":"./","_npmVersion":"1.3.24","_npmUser":{"name":"gjones","email":"foo@home.com"},"maintainers":[{"name":"gjones","email":"gregory.jones@turner.com"}]},"0.2.0":{"name":"express-rest-help","version":"0.2.0","private":false,"scripts":{"start":"node routes/Help.js"},"dependencies":{"express":"3.4.8","jade":"*","mocha":"~1.17.1","supertest":"~0.9.0"},"main":"routes/Help.js","directories":{"test":"test"},"devDependencies":{"mocha":"~1.17.1"},"repository":{"type":"git","url":"git@bitbucket.org:vgtf/teg-express-rest-help.git"},"keywords":["rest","help","express","rest","help","routedocs","route","help"],"author":{"name":"Greg Jones","email":"gregory.jones@turner.com","url":"http://none/"},"license":"ISC","description":"express-rest-help\r =================","_id":"express-rest-help@0.2.0","dist":{"shasum":"9725039c2d86b8819b1add3723cf940ee6448113","tarball":"https://registry.npmjs.org/express-rest-help/-/express-rest-help-0.2.0.tgz","integrity":"sha512-IBaQu0FUDlNQhLkOmSdzptRQwbBcxJbnLGwWNqil8F6+yHo9JFf7lXFVXIbt+XTUwlifr49jZYg2zcJAwqST3A==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCl/Xm5Kr4YatH2wlXGe1f2DaI3h8kpndnOFn0lc07FhwIgWWbnXpt0ulCGnTu9kskEFev2iYuLw9fHskJKTE/AaF0="}]},"_from":"./","_npmVersion":"1.3.21","_npmUser":{"name":"gjones","email":"gregory.jones@turner.com"},"maintainers":[{"name":"gjones","email":"gregory.jones@turner.com"}]},"0.3.0":{"name":"express-rest-help","version":"0.3.0","private":false,"scripts":{"start":"node routes/Help.js"},"dependencies":{"express":"3.4.8","jade":"*","mocha":"~1.17.1","supertest":"~0.9.0"},"main":"routes/Help.js","directories":{"test":"test"},"devDependencies":{"mocha":"~1.17.1"},"repository":{"type":"git","url":"git@bitbucket.org:vgtf/teg-express-rest-help.git"},"keywords":["rest","help","express","rest","help","routedocs","route","help"],"author":{"name":"Greg Jones","email":"gregory.jones@turner.com","url":"http://none/"},"license":"ISC","description":"express-rest-help\r =================","_id":"express-rest-help@0.3.0","dist":{"shasum":"a943e44821bf74234999440ac917c114b068a1e0","tarball":"https://registry.npmjs.org/express-rest-help/-/express-rest-help-0.3.0.tgz","integrity":"sha512-m1pgRsVXJQd1EW9se1XPLTgGhqCVqqjcgzUtKoM4iqzjN9iuuyOjVLmjFznC0bVQ5OlYVGgYRYult+O2AOI49A==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGxE8KL2EANbtAQcqi+XlflZmx5FDbfF2xa6yIDokhV0AiBG/SYnPOoU3XP2lkF90Hi4HD6Um9z4aBrUezbhBg50rg=="}]},"_from":"./","_npmVersion":"1.3.21","_npmUser":{"name":"gjones","email":"gregory.jones@turner.com"},"maintainers":[{"name":"gjones","email":"gregory.jones@turner.com"}]},"0.4.0":{"name":"express-rest-help","version":"0.4.0","private":false,"scripts":{"start":"node routes/Help.js"},"dependencies":{"express":"3.4.8","jade":"*","mocha":"~1.17.1","supertest":"~0.9.0"},"main":"routes/Help.js","directories":{"test":"test"},"devDependencies":{"mocha":"~1.17.1"},"repository":{"type":"git","url":"git@bitbucket.org:vgtf/teg-express-rest-help.git"},"keywords":["rest","help","express","rest","help","routedocs","route","help"],"author":{"name":"Greg Jones","email":"gregory.jones@turner.com","url":"http://none/"},"license":"ISC","description":"express-rest-help\r =================","_id":"express-rest-help@0.4.0","dist":{"shasum":"722cd2366b5ded2d1593821e4afe375169d1a465","tarball":"https://registry.npmjs.org/express-rest-help/-/express-rest-help-0.4.0.tgz","integrity":"sha512-CLnQ3RDHnrzRgb4htamfLr2v1cHXftIkbBdns1GtuNNJEiYlOWxUpyr2mjX7awySiGRipjfGzgBftci/6dL6Fg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCDJit7DpOro4vpfT9nPjkPAQ1J8lFR6idxEJkGALoJVgIgfVKY30NvLZUc//+PL/3X0mmKn2FZvlN8B2ed4oqPTU8="}]},"_from":".","_npmVersion":"1.3.21","_npmUser":{"name":"gjones","email":"gregory.jones@turner.com"},"maintainers":[{"name":"gjones","email":"gregory.jones@turner.com"}]},"0.5.0":{"name":"express-rest-help","version":"0.5.0","private":false,"scripts":{"start":"node routes/Help.js"},"dependencies":{"express":"3.4.8","jade":"*","mocha":"~1.17.1","supertest":"~0.9.0"},"main":"routes/Help.js","directories":{"test":"test"},"devDependencies":{"mocha":"~1.17.1"},"repository":{"type":"git","url":"git@bitbucket.org:vgtf/teg-express-rest-help.git"},"keywords":["rest","help","express","rest","help","routedocs","route","help"],"author":{"name":"Greg Jones","email":"gregory.jones@turner.com","url":"http://none/"},"license":"ISC","description":"express-rest-help\r =================","_id":"express-rest-help@0.5.0","dist":{"shasum":"e183d1493845732051fba8c70ddbbe1a6377679d","tarball":"https://registry.npmjs.org/express-rest-help/-/express-rest-help-0.5.0.tgz","integrity":"sha512-1tOD7IAnnMrvFK7rqyC+I1/OXhRu2iMS11K5cbA6Z9k28ljLG+A9zlytHAfpWbToutpxPfpzcX8zKcTLobiwSg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFAxUzbgNevDMP4YPE7U0OCMBqdrT6xmXlZr7wqHwsg/AiEAuVKXZd6y5LJnp8IF7jJbS+4zJszz0oBhjkxXlFSyl7E="}]},"_from":".","_npmVersion":"1.3.21","_npmUser":{"name":"gjones","email":"gregory.jones@turner.com"},"maintainers":[{"name":"gjones","email":"gregory.jones@turner.com"}]}},"readme":"express-rest-help\r\n=================\r\n\r\nThis module renders pretty (Twitter Bootstrap styled) help topics for each RESTful path in your Express app. This is an easy way to provide documentation for your Nodejs Express REST API/APP.\r\n\r\n![alt text](https://bitbucket.org/vgtf/teg-express-rest-help/raw/ac3672e4d3ca1bd9c4a9a08c93f04df89ef36b2f/advanced-screenshot.png \"Simple Example\")\r\n\r\n\r\nUsage\r\n--------\r\n\r\nInclude express-rest-help\r\n\r\n    var help = require(\"express-rest-help\");\r\n\r\nSet your routes as normal\r\n\r\n    var express = require('express');\r\n    var app = express();\r\n    app.get(\"/some-route\",function(req,res){res.send(\"something\")});\r\n\r\n    app.get(\"/another-route/:param1/(:param2)?\",function(req,res){res.send(\"another-route\")}\r\n\r\nTell help to render help for your routes\r\n\r\n    help.use(app);\r\n\r\nNavigate to your **http://{your-running-app}:{your-port}/help** in the browser to see your handywork\r\n\r\n![alt text](https://bitbucket.org/vgtf/teg-express-rest-help/raw/ac3672e4d3ca1bd9c4a9a08c93f04df89ef36b2f/simple-screenshot.png \"Simple Example\")\r\n\r\n\r\nAdvanced Help  - Help Files (Adding more HELPful help to your RESTful calls)\r\n------------\r\n\r\nexpress-rest-help creates a **/public/helplfiles** directory in your app on first startup.  If you place a .html file in the directory, the help module\r\nwill process the file in following manner:\r\n\r\n1. Let's say we create a file called **/public/helpfiles/example-override.html**\r\n\r\n        prompt> echo \"@@/another-route/:param1/(:param2)?|GET\" >  \r\n                      example-override.html\r\n\r\n2. Note, the first line of the file now contains two **@@** signs followed by the following pattern[express-path] | [method]\r\n\r\n        \"@@/another-route/:param1/(:param2)?|GET\r\n\r\n3. express-rest-help will use your-file-name.html (minus the dashes) to create a help topic \r\n\r\n        prompt> ls\r\n                    example-override.html       \r\n\r\n4. Include any HTML you wish in the file\r\n\r\n        <li>Note: The system will NOT start up if the Mongo connection is invalid\r\n        <code>\r\n        <pre>\r\n        //from MongoSetup.js\r\n        var mongoose = require('mongoose');\r\n        mongoose.connect('mongodb://localhost/sampledb');\r\n        var db = mongoose.connection;\r\n        db.on('error', function(e){\r\n            console.log(\"Mongo Failed to Start correctly.  Application will Exit due to Error : \"+e);\r\n            process.exit(1);\r\n        })  db.once('open', function callback () {\r\n                console.log(\"Application startup success. Mongo Database is ready to serve requests\");\r\n        });\r\n        </pre>\r\n        </code>\r\n        <li>When everything is good, you should see the following json Response\r\n        <code>\r\n        <pre>\r\n        {\r\n          \"status\": \"Sample API is Alive\"\r\n        }\r\n        </pre>\r\n        </code>`\r\n\r\n5. View your new topic at **http://{your-running-app}:{your-port}/help**\r\n![alt text](https://bitbucket.org/vgtf/teg-express-rest-help/raw/ac3672e4d3ca1bd9c4a9a08c93f04df89ef36b2f/advanced-screenshot.png \"Simple Example\")\r\n","maintainers":[{"name":"gjones","email":"gregory.jones@turner.com"}],"time":{"modified":"2022-06-17T22:35:09.216Z","created":"2014-02-14T22:40:52.043Z","0.0.1":"2014-02-14T22:40:52.043Z","0.0.2":"2014-02-15T13:04:49.260Z","0.0.3":"2014-02-15T13:15:05.858Z","0.0.4":"2014-02-15T13:25:18.009Z","0.0.5":"2014-02-15T13:27:50.074Z","0.0.6":"2014-02-15T23:37:57.046Z","0.0.7":"2014-02-18T00:15:03.565Z","0.1.0":"2014-02-18T02:29:56.422Z","0.2.0":"2014-02-19T21:30:35.174Z","0.3.0":"2014-02-19T22:46:16.622Z","0.4.0":"2014-03-06T22:07:02.665Z","0.5.0":"2014-04-21T19:59:29.709Z"},"readmeFilename":"README.md","description":"express-rest-help\r =================","keywords":["rest","help","express","rest","help","routedocs","route","help"],"repository":{"type":"git","url":"git@bitbucket.org:vgtf/teg-express-rest-help.git"},"author":{"name":"Greg Jones","email":"gregory.jones@turner.com","url":"http://none/"},"license":"ISC","users":{"broxmgs":true,"yhnavein":true}}