Added responseModel support.

Author: Levente Bagi

CHANGELOG.md

@@ -1,10 +1,11 @@
 ### Next Release
 
+* [#110](https://github.com/tim-vandecasteele/grape-swagger/pull/110) - Added `responseModel` support - [@bagilevi](https://github.com/bagilevi).
+* [#105](https://github.com/tim-vandecasteele/grape-swagger/pull/105): Fixed compatibility with Swagger-UI - [@CraigCottingham](https://github.com/CraigCottingham).
+* [#87](https://github.com/tim-vandecasteele/grape-swagger/pull/87): Fixed mapping of `default` to `defaultValue` - [@m-o-e](https://github.com/m-o-e).
 * Rewritten .gemspec and removed Jeweler - [@dblock](https://github.com/dblock).
 * Added `GrapeEntity::VERSION` - [@dblock](https://github.com/dblock).
 * Added Rubocop, Ruby-style linter - [@dblock](https://github.com/dblock).
-* [#105](https://github.com/tim-vandecasteele/grape-swagger/pull/105): Fixed compatibility with Swagger-UI - [@CraigCottingham](https://github.com/CraigCottingham).
-* [#87](https://github.com/tim-vandecasteele/grape-swagger/pull/87): Fixed mapping of `default` to `defaultValue` - [@m-o-e](https://github.com/m-o-e).
 * Your Contribution Here
 
 ### 0.7.2 (February 6, 2014)

lib/grape-swagger.rb

@@ -131,7 +131,7 @@ def self.setup(options)
               ops.each do |path, op_routes|
                 operations = op_routes.map do |route|
                   notes       = as_markdown(route.route_notes)
-                  http_codes  = parse_http_codes(route.route_http_codes)
+                  http_codes  = parse_http_codes(route.route_http_codes, models)
 
                   models << if @@models.present?
                               @@models
@@ -374,14 +374,16 @@ def generate_typeref(type)
               end
             end
 
-            def parse_http_codes(codes)
+            def parse_http_codes(codes, models)
               codes ||= {}
-              codes.map do |k, v|
-                {
+              codes.map do |k, v, m|
+                models << m if m
+                code = {
                   code: k,
-                  message: v,
-                  # responseModel: ...
+                  message: v
                 }
+                code[:responseModel] = parse_entity_name(m) if m
+                code
               end
             end
 

spec/response_model_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe 'responseModel' do
+  before :all do
+    module Entities
+      class Something < Grape::Entity
+        expose :text, documentation: { type: 'string', desc: 'Content of something.' }
+      end
+
+      class Error < Grape::Entity
+        expose :code, documentation: { type: 'string', desc: 'Error code' }
+        expose :message, documentation: { type: 'string', desc: 'Error message' }
+      end
+    end
+
+    class ResponseModelApi < Grape::API
+      format :json
+      desc 'This returns something or an error',
+           entity: Entities::Something,
+           http_codes: [
+             [200, 'OK', Entities::Something],
+             [403, 'Refused to return something', Entities::Error]
+           ]
+
+      get '/something/:id' do
+        if params[:id] == 1
+          something = OpenStruct.new text: 'something'
+          present something, with: Entities::Something
+        else
+          error = OpenStruct.new code: 'some_error', message: 'Some error'
+          present error, with: Entities::Error
+        end
+      end
+
+      add_swagger_documentation
+    end
+  end
+
+  def app
+    ResponseModelApi
+  end
+
+  it 'should document specified models' do
+    get '/swagger_doc/something'
+    parsed_response = JSON.parse(last_response.body)
+    parsed_response['apis'][0]['operations'][0]['responseMessages'].should eq([
+      {
+        'code' => 200,
+        'message' => 'OK',
+        'responseModel' => 'Something'
+      },
+      {
+        'code' => 403,
+        'message' => 'Refused to return something',
+        'responseModel' => 'Error'
+      }
+    ])
+    parsed_response['models'].keys.should include 'Error'
+    parsed_response['models']['Error'].should eq(
+                                                   'id' => 'Error',
+                                                   'properties' => {
+                                                     'code' => { 'type' => 'string', 'description' => 'Error code' },
+                                                     'message' => { 'type' => 'string', 'description' => 'Error message' }
+                                                   }
+                                                 )
+  end
+end