generate swagger with headers

Author: Uysim

Gemfile.rails50

@@ -2,6 +2,7 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 5.0'
+gem 'rails', '~> 5.0.0'
 gem 'mime-types', '~> 2.99.3'
 gem 'rails-controller-testing'
+

lib/apipie/swagger_generator.rb

@@ -643,10 +643,27 @@ def swagger_params_array_for_method(method, path)
         add_params_from_hash(swagger_result, body_param_defs_hash)
       end
 
+      add_headers_from_hash(swagger_result, method.headers) if method.headers.present?
+
       swagger_result
     end
 
 
+    def add_headers_from_hash(swagger_params_array, headers)
+      swagger_headers = headers.map do |header|
+        {
+          name: header[:name],
+          in: 'header',
+          required: header[:options][:required],
+          description: header[:description],
+          type:  header[:options][:type] || 'string'
+        }
+
+      end
+      swagger_params_array.push(*swagger_headers)
+    end
+
+
     def add_params_from_hash(swagger_params_array, param_defs, prefix=nil, default_value_for_in=nil)
 
       if default_value_for_in
@@ -684,7 +701,7 @@ def add_params_from_hash(swagger_params_array, param_defs, prefix=nil, default_v
         end
       end
     end
-    
+
   end
 
 end

spec/controllers/apipies_controller_spec.rb

@@ -143,6 +143,7 @@
       assert_response :success
       expect(response.body).to match(/"swagger":"2.0"/)
       # puts response.body
+
       expect(JSON::Validator.validate(swagger_schema, response.body)).to be_truthy
     end
 

spec/controllers/users_controller_spec.rb

@@ -482,7 +482,8 @@ def reload_controllers
             name: :OptionalHeaderName,
             description: 'Optional header description',
             options: {
-              required: false
+              required: false,
+              type: "string"
             }
           }
         end

spec/dummy/app/controllers/users_controller.rb

@@ -291,7 +291,7 @@ def create_route
 
   api :GET, '/users/action_with_headers'
   header :RequredHeaderName, 'Required header description', required: true
-  header :OptionalHeaderName, 'Optional header description', required: false
+  header :OptionalHeaderName, 'Optional header description', required: false, type: 'string'
   def action_with_headers
   end
 end

spec/lib/swagger/openapi_2_0_schema.json

@@ -1604,4 +1604,4 @@
       }
     }
   }
-}
+}

spec/lib/swagger/swagger_dsl_spec.rb

@@ -558,6 +558,7 @@ def have_field?(field, expected_name, breadcrumb)
 
         expect(returns_obj.code).to eq(200)
         expect(returns_obj.is_array?).to eq(false)
+
         expect(returns_obj).to match_field_structure([:pet_name, :animal_type, :age])
       end