Routes can now be easily hidden from docs generator

geek · geek · commit 2cb35abb3fc9 · 2013-01-29T10:44:15.000-06:00
diff --git a/README.md b/README.md
@@ -625,6 +625,7 @@ to write additional text as the configuration itself serves as a living document
         - _'raw'_ - the payload is read and stored in _'request.rawBody'_ but not parsed.
         - _'parse'_ - the payload is read and stored in _'request.rawBody'_ and then parsed (JSON or form-encoded) and stored in _'request.payload'_.
     - `cache` - if the server `cache` option is enabled and the route method is 'GET', the route can be configured to use the cache as described in [Caching](#caching).
+    - `docs` - if set to false then the route will be hidden from the documentation generator.
     - `pre` - an array with pre-handler methods as described in [Route Prerequisites](#route-prerequisites). 
     - `auth` - authentication configuration
         - `mode` - the authentication mode. Defaults to _'required'_ is the `authentication` server option is set, otherwise _'none'_. Available options include:
diff --git a/lib/docs.js b/lib/docs.js
@@ -32,10 +32,12 @@ exports.handler = function (route, config) {
 
             routes.push(request.server._match('get', path));
             routes.push(request.server._match('post', path));
+            routes.push(request.server._match('delete', path));
+            routes.push(request.server._match('put', path));
 
             routes = routes.filter(function (item) {
 
-                return !!item;
+                return item && item.config.docs !== false;
             });
 
             if (!routes.length) {
@@ -48,7 +50,7 @@ exports.handler = function (route, config) {
         routes = request.server._routeTable();
         routes = routes.filter(function (item) {
 
-            return item && item.path !== route.path;
+            return item && item.path !== route.path && item.config.docs !== false && item.method !== 'options';
         });
 
         routes.sort(function (route1, route2) {
diff --git a/test/integration/docs.js b/test/integration/docs.js
@@ -29,26 +29,27 @@ describe('Docs Generator', function () {
 
     function setupServer(done) {
 
-        _server = new Hapi.Server('0.0.0.0', 0);
+        _server = new Hapi.Server();
         _server.addRoutes([
             { method: 'GET', path: '/docs', handler: { docs: { routeTemplate: _routeTemplate, indexTemplate: _indexTemplate } } },
             { method: 'GET', path: '/defaults', handler: { docs: true } },
             { method: 'GET', path: '/test', config: { handler: handler, query: { param1: S().required() } } },
-            { method: 'POST', path: '/test', config: { handler: handler, query: { param2: S().valid('first', 'last') } } }
+            { method: 'POST', path: '/test', config: { handler: handler, query: { param2: S().valid('first', 'last') } } },
+            { method: 'GET', path: '/notincluded', config: { handler: handler, docs: false } }
         ]);
 
-        _server.start(done);
+        done();
     }
 
     function setupServerWithoutPost(done) {
 
-        _serverWithoutPost = new Hapi.Server('0.0.0.0', 0);
+        _serverWithoutPost = new Hapi.Server();
         _serverWithoutPost.addRoutes([
             { method: 'GET', path: '/docs', handler: { docs: { routeTemplate: _routeTemplate, indexTemplate: _indexTemplate } } },
             { method: 'GET', path: '/test', config: { handler: handler, query: { param1: S().required() } } }
         ]);
 
-        _serverWithoutPost.start(done);
+        done();
     }
 
     function makeRequest(path, callback) {
@@ -88,7 +89,7 @@ describe('Docs Generator', function () {
 
         makeRequest('/docs', function (res) {
 
-            expect(res).to.equal('/defaults|/defaults|/test|/test|/test|/test|');
+            expect(res).to.equal('/defaults|/test|/test|');
             done();
         });
     });
@@ -102,6 +103,15 @@ describe('Docs Generator', function () {
         });
     });
 
+    it('the index does\'t include routes that are configured with docs disabled', function (done) {
+
+        makeRequest('/docs', function (res) {
+
+            expect(res).to.not.contain('/notincluded');
+            done();
+        });
+    });
+
     it('shows template when correct path is provided using defaults', function (done) {
 
         makeRequest('/defaults?path=/test', function (res) {
