Merge branch 'pr/63'

Author: Tim Vandecasteele

CHANGELOG.markdown

@@ -2,6 +2,7 @@
 
 * Fix: translate parameter `type` to String, enables using Mongoid fields as parameter definitions - [@dblock](https://github.com/dblock).
 * Adding support for generating swagger responseClass and models from Grape Entities - [@calebwoods](https://github.com/calebwoods).
+* Adding hidden endpoints - [@arturoherrero](https://github.com/arturoherrero).
 * Your Contribution Here
 
 ### 0.6.0 (June 19, 2013)

README.markdown

@@ -53,8 +53,7 @@ You can pass a hash with some configuration possibilities to ```add_swagger_docu
 
 ## Swagger Header Parameters
 
-Swagger also supports the documentation of parameters passed in the header. Since grape's ```params[]``` doesn't return header parameters we can
-to specify header parameters seperately in a block after the description.
+Swagger also supports the documentation of parameters passed in the header. Since grape's ```params[]``` doesn't return header parameters we can specify header parameters seperately in a block after the description.
 
 ``` ruby
 desc "Return super-secret information", {
@@ -70,7 +69,18 @@ desc "Return super-secret information", {
   }
 }
 ```
-### Grape Entities
+
+## Hiding an endpoint
+
+You can hide an endpoint by adding ```:hidden => true``` in the description of the endpoint:
+
+``` ruby
+desc 'Hide this endpoint', {
+  :hidden => true
+}
+```
+
+## Grape Entities
 
 Add the [grape-entity](https://github.com/agileanimal/grape-entity) gem to our Gemfile.
 Please refer to the [grape-entity documentation](https://github.com/gileanimal/grape-entity/blob/master/README.markdown)

lib/grape-swagger.rb

@@ -65,9 +65,10 @@ def self.setup(options)
                 routes.reject!{ |route, value| "/#{route}/".index(parse_path(@@mount_path, nil) << '/') == 0 }
               end
 
-              routes_array = routes.keys.map do |local_route|
-                  { :path => "#{parse_path(route.route_path.gsub('(.:format)', ''),route.route_version)}/#{local_route}#{@@hide_format ? '' : '.{format}'}" }
-              end
+              routes_array = routes.keys.map { |local_route|
+                next if routes[local_route].all? { |route| route.route_hidden }
+                { :path => "#{parse_path(route.route_path.gsub('(.:format)', ''),route.route_version)}/#{local_route}#{@@hide_format ? '' : '.{format}'}" }
+              }.compact
 
               {
                 apiVersion: api_version,
@@ -87,7 +88,8 @@ def self.setup(options)
               header['Access-Control-Request-Method'] = '*'
               models = []
               routes = @@target_class::combined_routes[params[:name]]
-              routes_array = routes.map do |route|
+              routes_array = routes.map { |route|
+                next if route.route_hidden
                 notes = route.route_notes && @@markdown ? Kramdown::Document.new(strip_heredoc(route.route_notes)).to_html : route.route_notes
                 http_codes = parse_http_codes route.route_http_codes
                 models << route.route_entity if route.route_entity
@@ -105,7 +107,7 @@ def self.setup(options)
                   :path => parse_path(route.route_path, api_version),
                   :operations => [operations]
                 }
-              end
+              }.compact
 
               api_description = {
                 apiVersion: api_version,

spec/hide_api_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe "a hide mounted api" do
+  before :all do
+    class HideMountedApi < Grape::API
+      desc 'Show this endpoint'
+      get '/simple' do
+        { :foo => 'bar' }
+      end
+
+      desc 'Hide this endpoint', {
+        :hidden => true
+      }
+      get '/hide' do
+        { :foo => 'bar' }
+      end
+    end
+
+    class HideApi < Grape::API
+      mount HideMountedApi
+      add_swagger_documentation
+    end
+  end
+
+  def app; HideApi end
+
+  it "retrieves swagger-documentation that doesn't include hidden endpoints" do
+    get '/swagger_doc.json'
+    JSON.parse(last_response.body).should == {
+      "apiVersion" => "0.1",
+      "swaggerVersion" => "1.1",
+      "basePath" => "http://example.org",
+      "operations" => [],
+      "apis" => [
+        { "path" => "/swagger_doc/simple.{format}" },
+        { "path" => "/swagger_doc/swagger_doc.{format}" }
+      ]
+    }
+  end
+end
+
+
+describe "a hide mounted api with same namespace" do
+  before :all do
+    class HideNamespaceMountedApi < Grape::API
+      desc 'Show this endpoint'
+      get '/simple/show' do
+        { :foo => 'bar' }
+      end
+
+      desc 'Hide this endpoint', {
+        :hidden => true
+      }
+      get '/simple/hide' do
+        { :foo => 'bar' }
+      end
+    end
+
+    class HideNamespaceApi < Grape::API
+      mount HideNamespaceMountedApi
+      add_swagger_documentation
+    end
+  end
+
+  def app; HideNamespaceApi end
+
+  it "retrieves swagger-documentation on /swagger_doc" do
+    get '/swagger_doc.json'
+    JSON.parse(last_response.body).should == {
+      "apiVersion" => "0.1",
+      "swaggerVersion" => "1.1",
+      "basePath" => "http://example.org",
+      "operations" => [],
+      "apis" => [
+        { "path" => "/swagger_doc/simple.{format}" },
+        { "path" => "/swagger_doc/swagger_doc.{format}" }
+      ]
+    }
+  end
+
+  it "retrieves the documentation for mounted-api that doesn't include hidden endpoints" do
+    get '/swagger_doc/simple.json'
+    JSON.parse(last_response.body).should == {
+      "apiVersion" => "0.1",
+      "swaggerVersion" => "1.1",
+      "basePath" => "http://example.org",
+      "resourcePath" => "",
+      "apis" => [
+        {
+          "path" => "/simple/show.{format}",
+          "operations" => [
+            {
+              "notes" => nil,
+              "summary" => "Show this endpoint",
+              "nickname" => "GET-simple-show---format-",
+              "httpMethod" => "GET",
+              "parameters" => []
+            }
+          ]
+        }
+      ]
+    }
+  end
+end