Swagger export: Ability to include default values in headers

Author: nikosmichas

lib/apipie/swagger_generator.rb

@@ -651,14 +651,15 @@ def swagger_params_array_for_method(method, path)
 
     def add_headers_from_hash(swagger_params_array, headers)
       swagger_headers = headers.map do |header|
-        {
+        header_hash = {
           name: header[:name],
           in: 'header',
           required: header[:options][:required],
           description: header[:description],
           type:  header[:options][:type] || 'string'
         }
-
+        header_hash[:default] = header[:options][:default] if header[:options][:default]
+        header_hash
       end
       swagger_params_array.push(*swagger_headers)
     end

spec/controllers/users_controller_spec.rb

@@ -488,12 +488,24 @@ def reload_controllers
           }
         end
 
+        let(:expected_header_with_default) do
+          {
+            name: :HeaderNameWithDefaultValue,
+            description: 'Header with default value',
+            options: {
+              required: true,
+              default: 'default value'
+            }
+          }
+        end
+
         it 'contains all headers description in method doc' do
           headers = Apipie.get_method_description(UsersController, :action_with_headers).headers
           expect(headers).to be_an(Array)
 
           compare_hashes headers[0], expected_required_header
           compare_hashes headers[1], expected_optional_header
+          compare_hashes headers[2], expected_header_with_default
         end
       end
 

spec/dummy/app/controllers/users_controller.rb

@@ -292,6 +292,7 @@ def create_route
   api :GET, '/users/action_with_headers'
   header :RequredHeaderName, 'Required header description', required: true
   header :OptionalHeaderName, 'Optional header description', required: false, type: 'string'
+  header :HeaderNameWithDefaultValue, 'Header with default value', required: true, default: 'default value'
   def action_with_headers
   end
 end