Parsing exception with swagger interface generated with grape-swagger gem about swagger-codegen

[fehguy]

Looks like you are missing the responseClass. The error reporting is not good right now but the trace points here:

https://github.com/wordnik/swagger-codegen/blob/master/src/main/scala/com/wordnik/swagger/model/SwaggerModelSerializer.scala#L139

[bfreeman123]

Thanks for the response. That's what I figured. So I guess my question is as follows. Is there a reason why certain fields are required in swagger-codegen but are not required in swagger-ui? Again, I am simply feeding the output from grape-swagger into both, and it works in swagger-ui, but not in swagger-codegen.

[fehguy]

Yes, the code generator is more strict with structure that the ui. Valid swagger specs are best, of course.

[bfreeman123]

Thanks again for the explanation. I was able to get this to work by monkey-patching the swagger-grape gem to add the responseClass and errorResponses keys to Operations, and added the models key to the ApiListing (all of which are missing in the most recent version of the gem). I'll submit a pull request to the grape-swagger project that will implement these missing keys.

[fehguy]

Thank you. And we will improve the validator messages as well as make a javascript version that's bundled with Swagger-ui.

[berlincount]

bfreeman123, did you ever submit that pull request? I'm running into the same issues ..

[bfreeman123]

No, I did not. While my patch got the code generator over that hurdle, it merely spit out un-usable code (at least for objective-c). As I recall, it wasn't mapping attributes correctly. I have since moved onto another project and abandoned the swagger codegen, but if you'd like to give it a try, you can simply add the responseClass key to the Operations hash on the grape-swagger gem.

If you look at https://github.com/tim-vandecasteele/grape-swagger/blob/master/lib/grape-swagger.rb starting on line 91, you essentially want to change:

operations = {
  :notes => notes,
  :summary => route.route_description || '',
  :nickname   => route.route_method + route.route_path.gsub(/[\/:\(\)\.]/,'-'),
  :httpMethod => route.route_method,
  :parameters => parse_header_params(route.route_headers) +
  parse_params(route.route_params, route.route_path, route.route_method)
}

to

operations = {
  :notes => notes,
  :summary => route.route_description || '',
  :nickname   => route.route_method + route.route_path.gsub(/[\/:\(\)\.]/,'-'),
  :httpMethod => route.route_method,
  :parameters => parse_header_params(route.route_headers) +
  parse_params(route.route_params, route.route_path, route.route_method),
  :responseClass => @@class_name
}