Merge pull request #40 from boocx2/master

new :hide_format option for add_swagger_documentation

Author: tim-vandecasteele

lib/grape-swagger.rb

@@ -40,7 +40,8 @@ def self.setup(options)
               :base_path => nil,
               :api_version => '0.1',
               :markdown => false,
-              :hide_documentation_path => false
+              :hide_documentation_path => false,
+              :hide_format => false
             }
             options = defaults.merge(options)
 
@@ -49,6 +50,7 @@ def self.setup(options)
             @@class_name = options[:class_name] || options[:mount_path].gsub('/','')
             @@markdown = options[:markdown]
             @@hide_documentation_path = options[:hide_documentation_path]
+            @@hide_format = options[:hide_format]
             api_version = options[:api_version]
             base_path = options[:base_path]
 
@@ -63,7 +65,7 @@ def self.setup(options)
               end
 
               routes_array = routes.keys.map do |local_route|
-                  { :path => "#{parse_path(route.route_path.gsub('(.:format)', ''),route.route_version)}/#{local_route}.{format}" }
+                  { :path => "#{parse_path(route.route_path.gsub('(.:format)', ''),route.route_version)}/#{local_route}#{@@hide_format ? '' : '.{format}'}" }
               end
               {
                 apiVersion: api_version,
@@ -158,17 +160,17 @@ def parse_header_params(params)
 
             def parse_path(path, version)
               # adapt format to swagger format
-              parsed_path = path.gsub('(.:format)', '.{format}')
+              parsed_path = path.gsub '(.:format)', ( @@hide_format ? '' : '.{format}')
               # This is attempting to emulate the behavior of
               # Rack::Mount::Strexp. We cannot use Strexp directly because
               # all it does is generate regular expressions for parsing URLs.
               # TODO: Implement a Racc tokenizer to properly generate the
               # parsed path.
               parsed_path = parsed_path.gsub(/:([a-zA-Z_]\w*)/, '{\1}')
               # add the version
-              parsed_path = parsed_path.gsub('{version}', version) if version
-              parsed_path
+              version ? parsed_path.gsub('{version}', version) : parsed_path
             end
+
             def parse_http_codes codes
               codes ||= {}
               codes.collect do |k, v|

spec/non_default_api_spec.rb

@@ -229,4 +229,27 @@ def app; SimpleApiWithProtection; end
       last_response.body.should == "{:apiVersion=>\"0.1\", :swaggerVersion=>\"1.1\", :basePath=>\"https://example.org:80\", :resourcePath=>\"\", :apis=>[{:path=>\"/something.{format}\", :operations=>[{:notes=>nil, :summary=>\"this gets something\", :nickname=>\"GET-something---format-\", :httpMethod=>\"GET\", :parameters=>[]}]}]}"
     end
   end
+
+  context ":hide_format" do
+    before(:all) do
+      class HidePathsApi < Grape::API
+        desc 'this gets something'
+        get '/something' do
+          {:bla => 'something'}
+        end
+      end
+
+      class SimpleApiWithHiddenPaths < Grape::API
+        mount ProtectedApi
+        add_swagger_documentation :hide_format => true
+      end
+    end
+
+    def app; SimpleApiWithHiddenPaths; end
+
+    it "has no formats" do
+      get '/swagger_doc/something'
+      last_response.body.should == "{:apiVersion=>\"0.1\", :swaggerVersion=>\"1.1\", :basePath=>\"http://example.org\", :resourcePath=>\"\", :apis=>[{:path=>\"/something\", :operations=>[{:notes=>nil, :summary=>\"this gets something\", :nickname=>\"GET-something---format-\", :httpMethod=>\"GET\", :parameters=>[]}]}]}"
+    end
+  end
 end