Hi,
my grape APIs are protected against CSRF through a X-CSRF-Token request header. The value that has to go into this header is sent by the server to clients through a cookie.

Is there a way to customise grape-swagger-rails to add this header to every request?
Ex.

xhr.setRequestHeader('X-CSRF-Token', $.cookie('CSRF-Token'))

In the swagger demo i can see that section like this:

But in my application it does not show:

Hello,
Please exclude grape and grape-swagger from gem dependencies. Main reason for this usage of grape-swagger-rails only as swagger-ui without code that depends on grape or/and grape-swagger.

Is it possible to use "request" data to generate a default app_url that is always relative to the host where it was accessed from?

While we don't use it in a multi tenancy application (which would be a valid use case for that), our current development environment have some host variations that cannot be easily (in a clear way) bypassed.

Right now grape-swagger-rails expects to be mounted only once, at a single route. It also expects a single global definition of options.url, options.app_url, etc.

It would be really useful if we could mount multiple "swagger roots", just like we can mount multiple APIs at different routes using Grape itself. I think it'll also go a long way towards supporting issues like ruby-grape/grape-swagger#141 and at the very least provide a nice workaround

Would this be something you'd be open to supporting? I'm thinking it'll look something like you can specify a set of options per-mount and you can mount multiple subclasses of GrapeSwaggerRails::Engine at different routes.

P/S: The reason we need this now is due to Swagger 2.0's decision to only support one endpoint/operation for each (unique resource path + HTTP method) combo. The version of swagger-ui vendored here assumes this and only documents the last-mounted endpoint for each path. Since we use accept-header-only versioning, obviously this is very bad for us.

Is there a way to namespace request routes generated by Grape::API endpoints?

I am using grape and grape-swagger-rails inside a rails engine and the URLs generated in the swagger UI don't include that namespace.

Ex.
My engine is called BlogManager an my routes file looks like this:

mount GrapeSwaggerRails::Engine, at: "/documentation"

The problem is that in the UI the generated URLs look like these:

• /api/v1/tags (GET)
• /api/v1/tags (POST)

which don't have the namespace /blog_manager and the try it out button obviously fail.

Running into trouble with configuration for my rails app. I'm using the following versions

#Gemfile.lock
grape (0.14.0)
grape-swagger (0.10.4)
grape-swagger-rails (0.2.0)

I have the following initializer:

#config/initializer/swagger.rb
GrapeSwaggerRails.options.before_filter_proc = proc {
  GrapeSwaggerRails.options.app_url = request.protocol + request.host_with_port
}
GrapeSwaggerRails.options.url = '/api/v1/swagger_doc.json'

And I have the following API class:

#app/api/api.rb
require 'grape-swagger'

class API < Grape::API
  prefix 'api'
  version 'v1', using: :path

  mount People::List
  mount Person::Single

  add_swagger_documentation 
end

The following routes:

#config/routes.rb
mount API => '/'
mount GrapeSwaggerRails::Engine => '/api-docs'

When I visit /api-docs everything appears to start to load correctly but the AJAX calls being made by swagger-ui.js are hitting urls formatted like this: http://somedomain/api/v1/swagger_doc.json/people.json

I have no idea now what is causing /swagger_doc.json to be dropped inside of the request urls?

I feel like I am missing something fundamental but I haven't been able to figure it out. Any information that might be helpful would be appreciated.

Thanks

Dear develeoper(s),

I have a server with multiple rails apps, each one deployed with a subURI scheme (like "www.lorem.ipsum/app_name/").
I configured your gem so the UI comes up with the following URL"http://www.lorem.ipsum/dbkzakat/takearest/apidoc" -> mount GrapeSwaggerRails::Engine, at: "/takearest/apidoc"

At the bottom of the screen a valid URL ist shown: [ base url: http://www.lorem.ipsum/dbkzakat/takearest/swagger_doc , api version: v1 ]
On top of the screen, also a valid URL shows up: http://www.lorem.ipsum/dbkzakat/takearest/swagger_doc

This works fine so far, now for the problem :)
When I play around with the parameters and if I submit via the "Try it out!" button, a mangled URL is generated which won't work in my case:

http://www.lorem.ipsum:80/takearest/v1/search/label/any?q=politik&qt=contains&lang=de

As you can see, the subURI part "dbkzakat" is missing! The REST service is perfectly fine, it works, if you alter the URL so it will contain the subURI part.

To clarify, I added a screenshot :)

What's wrong here? Could you please have a look at it?

Hello, I'm using this method to set API key default value:

GrapeSwaggerRails.options.before_action do |request|
  GrapeSwaggerRails.options.api_key_default_value = some_key
end

It fills the input, but it doesn't send the key. To force it to do so I need too trigger js change event on the input, e.g. add space, press enter, remove space, press enter again.

In the source code it looks like the only thing api_key_default_value does is setting the initial value of the input. It doesn't trigger change event that would actually update the key that is used.

Is it a bug or am I doing something wrong here? If it's a bug, I can prepare PR to fix it.

Below is the configuration I used to build API's using Grape.

But I am not able to build documentation using Swagger

Gems:

gem 'grape'
grape-0.13.0
gem 'grape-swagger-rails'
grape-swagger-rails-0.1.0
gem 'rack-cors', :require => 'rack/cors'
rack-cors-0.4.0

config/application.rb

require 'rack/cors'
config.paths.add File.join('app', 'api'), glob: File.join('**', '*.rb') 
config.autoload_paths += Dir[Rails.root.join('app', 'api', '**', '*.rb')]

config/initializers/swagger.rb

GrapeSwaggerRails.options.url      = '/swagger_doc.json'
GrapeSwaggerRails.options.app_url  = "http://api.lvh.me:3000"

config/routes.rb

  constraints(subdomain: 'api') do
    mount API::Base => '/'
  end
  mount GrapeSwaggerRails::Engine, at: "/apidocs"

app/api/api/base.rb

require 'grape-swagger'
module API
  class Base < Grape::API
    default_format :json
    mount API::V1::Base

    add_swagger_documentation(
      api_version: "v1",
      hide_documentation_path: true,
      mount_path: "/",
      hide_format: true
    )
  end
end

Issue:

When I hit http://lvh.me:3000/apidocs. I'm getting below error below green Nav bar.

Can't read swagger JSON from http://api.lvh.me:3000/swagger_doc.json

When I hit http://api.lvh.me:3000/swagger_doc.json. Getting below response.

{"error":"Not Found"}

I am not able to figure out what am doing wrong. Need help in rendering Swagger documentation with grape framework.

http://stackoverflow.com/questions/33843077/grape-swagger-documentation-not-loading

Will this be available for the newest versions of Grape?

Hi guys,

I'm using grape-swagger-rails (0.3.0) to generate the documentation for a JSON API. I have an issue with all the actions expecting a payload in JSON format : indeed, the documentation generates a request body with the application/x-www-form-urlencoded format, and my API only handles application/json format.

Therefore, all the "Try it out" actions on the documentation for POST/PUT/PATCH requests are non-functional.

I've tried to manually add a Content-Type header in the GrapeSwaggerRails initialization section, but it doesn't seem to be taken into account :

GrapeSwaggerRails.options.headers[ 'Content-Type' ] = 'application/json'

Am I missing something in the configuration of my endpoints / of grape-swagger-rails here ? I've found nothing around here in the documentation.

EDIT: actually it looks like the payload is correctly understood by my API endpoint on POST and PATCH, but not on PUT requests... in case it helps. Any clues ? When I click "Try it out", I get this in the console for a PUT request only :

Currently grape-swagger-rails has hard-coded support for passing through a few of the Swagger-UI options from the grape-swagger-rails initializer to the SwaggerUi initializer, in the index.html.erb file. Good examples of this include the docExpansion option, and the validatorUrl option. Here's a link to a recent pull request that added the validatorUrl option: #46.

@dblock rightfully pointed out that it would be better if we could come up with a clean way to pass through ALL of the Swagger-UI options, to completely support the features of Swagger-UI. Then we could strip out all the special case code that we currently have for supporting these options piecemeal.

There's a complete list of Swagger-UI options here: https://github.com/swagger-api/swagger-ui#parameters. I wonder if we might be best off making some kind of a whitelist of supported parameters to pass through, rather than just automatically passing through any and all options that are set. It will require a little more maintenance since when new options are added they would have to be added to the whitelist, but it might head off potential security issues.

Another point in favor of using some kind of list of supported parameters... it looks like the Swagger-UI params don't use a completely consistent case. Most are lowerCamelCase, but at least one (dom_id) is snake_case, which means that automatically converting from snake_case in the grape_swagger_rails.rb initializer to lowerCamelCase will fail in that case. Seems that a list showing how to translate from the Ruby name for the parameter to the JavaScript name for the parameter may be needed.

Hi,

I wanted to discuss the "out of the box" compatibility of grape-swagger and grape-swagger-rails. It seems that when you install grape-swagger-rails (0.1.0) while using grape (0.11.0) and grape-swagger (0.10.1), you need to set options that aren't obvious from the README.

The first error I encountered was that when you setup grape-swagger-rails, there is an flash of errors that override each other and end with:

swagger_doc' from path http://api.rails-app.dev:3000/swagger_doc/swagger_doc.json (server returned undefined)

The other flashed errors are the same message but swagger_doc replaced with your resource. From the rails log, I was able to see that it was requesting a resource that was suffixed with .json

Started GET "/swagger_doc/swagger_doc.json" for 127.0.0.1 at 2015-04-03 16:14:20 -0700

ActionController::RoutingError (No route matches [GET] "/swagger_doc/swagger_doc.json"):

But out of the box, grape-swagger only creates urls of the form (notice no .json):
/swagger_doc/swagger_doc

By changing
add_swagger_documentation
to:

add_swagger_documentation(format: :json)

I was able to resolve the problem.

I propose that one or more of the following happens:

1. The README for grape-swagger is changed.
2. The README for grape-swagger-rails is changed.
3. The code in grape-swagger automatically assumes the format of :json.
4. Something better that the authors know. :)

I'm happy to send a PR anywhere for anything. I'm going to ping @dblock because he is so awesome and responds to everything grape related.

The following issues are relevant:
https://github.com/tim-vandecasteele/grape-swagger/issues/190
https://github.com/tim-vandecasteele/grape-swagger/issues/197

Thanks for this great tool!

Is it possible to add an option to disable google font? There are some places in the world hard to access google service 😿

Do i need to do something to make this work on production or staging?

Now i get this error:

Hi, thanks for your nice work.
I am going to implement Authentication and Authorization for my Swagger UI.
After checking the documentation, I decided to use current_user inside GrapeSwaggerRails.options.before_filter.
Unfortunately it says current_user is undefined.
I am currently using clearance gem for authentication.

Regards
Oleg

Hi, I need to brand swagger so that it fits in with the organisation I am working for. How do I go about doing this without forking the gem?

Thanks

Hi there!

In modern Rails versions all controllers inherit from ApplicationController, but GrapeSwaggerRails::ApplicationController inherits ActionController::Base. By this reason methods that are defined at ApplicationController are not accessible from GrapeSwaggerRails context.

For example, if we have defined a method current_user in Rails ApplicationController

# application_controller.rb

class ApplicationController < ActionController::Base

  def current_user
    User.find(session[:user_id])
  end

end

If we use method current_user in a before_filter hook as described here, we have an error:

  GrapeSwaggerRails.options.before_action do |request|
    GrapeSwaggerRails.options.api_key_default_value = current_user.api_token
  end

  undefined local variable or method `current_user' for #<GrapeSwaggerRails::ApplicationController:0x007f88a1c5ac48>

This problem could be solved if GrapeSwaggerRails::ApplicationController inherits standard ApplicationController

Thanks for reading this!

Hey, this is a very nice project, but keeping swagger-ui dist files in the repository among with rake-task for downloading them makes me sad. I have an idea to add swagger-ui dist as a dependency in Gemfile. I can even make a PR with that. What do you think?

Hi,

Considering the following resource, It seems to generate an improper swagger Data Type Example Value:

module Test
  module V1
    class Ping < Grape::API
      resource :ping do
        desc "Are you alive!", tags: ['tools']
        params do
          requires :test, type: Hash, documentation: { param_type: 'body' } do
            requires :hash, type: Hash do
              requires :int_array, type: Array[Integer]
            end
          end
        end
        post do
          'pong'
        end
      end
    end
  end
end

This shows the following:

{
  "test": [
    {
      "hash": [
        {
          "int_array": 0
        }
      ]
    }
  ]
}

However I would expect:

{
  "test": {
    "hash": {
      "int_array": [0]
    }
  }
}

The model is also wrong:

postControlPing {
  test (Array[inline_model_11])
}
inline_model_11 {
  hash (Array[Inline Model 1], optional)
}
Inline Model 1 {
  int_array (integer)
}

it should be:

postControlPing {
  test (inline_model_11)
}
inline_model_11 {
  hash (Inline Model 1, optional)
}
Inline Model 1 {
  int_array (Array[integer])
}

It seems like the array breaks it and is set on every parent member instead of the element iteself.

As a quick fix i'm using:

        params do
          requires :test, type: Hash, documentation: { param_type: 'body' } do
            requires :hash, type: Hash do
              requires :int_array, type: Object, documentation: { type: 'Array[Integer]' }
            end
          end
        end

This prints out:

{
  "test": {
    "hash": {}
  }
}

and

postControlPing {
  test (inline_model_11)
}
inline_model_11 {
  hash (Inline Model 1, optional)
}
Inline Model 1 {
  int_array (Array[Integer])
}

The example isn't perfect but i can fix that with a note in the description of the endpoint.
Thanks

I have got issue with uploading files at 0.1.1 version of grape-swagger-rails
This is screenshot of swagger with grape-swagger-rails version 0.1.1

This errors comes after sending request:

And this is with 0.1.0

cc: @aschuster3 @serggl

API is Rails Api based
I have the css and javascript in the asset pipeline and they are being generated and are loading to the browser. However when viewing a api document page and clicking on the yellow box to populate the input field with the example it does nothing. Normally for swagger ui this does work. See petstore working example ... http://petstore.swagger.io/#!/pet/addPet and click the yellow example payload.

It doesnt seem to work on my grape-swagger-rails version :(

When i hit the swagger root page (not the page in question) I get a js error in console

When i visit the actual endpoint page (api/users) screen renders fine. Switch from model/example works. But clicking the yellow example box - does nothing :(

Via #86, cc: @serggl

I have this definition in my API

params do
requires :daycare_attributes, type: Hash do
  requires :departments_attributes, type: Array do
    requires :name
  end
end

The UI shows

Which is fine. But when I try it, it doesn't build the array properly. In the curl, it built something like

curl -X POST --header 'Content-Type: application/x-www-form-urlencoded' --header 'Accept: application/json' -d \
'daycare_attributes[departments_attributes]%5Bname%5D=Math&daycare_attributes[departments_attributes]%5Bname%5D=Phsyics' \
'http://localhost:3000/api/'

To pass the grape parameter validation. It must be

curl -X POST --header 'Content-Type: application/x-www-form-urlencoded' --header 'Accept: application/json' -d \
'daycare_attributes[departments_attributes][][name]=Math&daycare_attributes[departments_attributes][][name]=Phsyics'\
 'http://localhost:3000/api/'

Both curl and UI xhr failed to pass the validation.

💚 build on my fork: https://travis-ci.org/dblock/grape-swagger-rails/builds/49598923

It looks like this project is still being actively developed. Any chance of updating rubygems?

The view file includes options for swagger via

<html data-swagger-options="<%= GrapeSwaggerRails.options.marshal_dump.to_json %>">

but that is not html_safe, so the contents of the json string get escaped - we end up with " inside our json object.

I'm not sure if this is specific to rails 4, but I made it work properly locally by changing the above to

<html data-swagger-options='<%== GrapeSwaggerRails.options.marshal_dump.to_json %>'>

After updating grape-swagger to 20.1 version swagger won't load documentation. When I have opened Javascript console, it shows error messages:

 This API is using a deprecated version of Swagger!  Please see http://github.com/wordnik/swagger-core/wiki for more info
Uncaught TypeError: Cannot read property 'length' of undefined swagger-ui.min.self-bfe16e3….js?body=1:217

Hi authors,

I followed the 'grape-swagger-rails' documentation and the /swagger_doc.json initial page loads fine from swagger ui as follows:

But apart from this page all other requests, I am getting one of the 2 errors

1st Error: Unable to Load SwaggerUI
(I am testing '401 Unauthorised' page works or not with swagger documentation)

For this response Swagger ui is not loading and showing the following error:
Unable to Load SwaggerUI
apidoc:50 401 : http://g_m.lvh.me:3000/content/api/v1/activities/23

2nd Error: Uncaught TypeError: Cannot read property 'definitions' of null

(I am testing '200 Created' page works or not with swagger documentation)
For all other successful requests (200) where I am sending json response back, occurs the following error:
Uncaught TypeError: Cannot read property 'definitions' of null

NOTE: I implemented this on a Rails Engine that is mounted on '/content'

I tried a lot, feeling that any configuration I missed to include all these urls in swagger ui. But nothing I can found. Reply me if you have a solution for this else please fix this issue as soon as possible.

Currently, I face a problem when I try to access http://localhost:3000/swagger and it raise error
URI::InvalidURIError in GrapeSwaggerRails::Application#index
bad URI(is not URI?): file-digest:///home/../app/assets/config/grape_swagger_rails
Does anyone know how to fix this issue?

With previous applications running 0.7.2, I would initialise with
GrapeSwaggerRails.options.url = '/swagger_doc.json'

However, with v 0.9, had to replace that with
GrapeSwaggerRails.options.url = '/swagger_doc'
and remove the .json to get things to work

Hi,

Is there some way of setting up up Swagger Docs rails so it can use other methods in my application?
Also I would like to reuse my default layout in app/views/layouts/application.html.haml, is this possible?

I do have swagger docs working and displaying but I would like to "skin" it to look like the rest of my application.

Many thanks

P.S relatively noobie rails developer

Hi,

My initializer looks something like this:

GrapeSwaggerRails.options.tap do |o|
  # other details omitted
  o.before_filter do |request|
    authenticate_with_http_basic do |user, pass|
      user == ENV['basic_auth_username'] && password == ENV['basic_auth_password']
    end
  end
  o.api_auth     = 'bearer'
  o.api_key_name = 'Authorization'
  o.api_key_type = 'header'
end

When I fill in my API key and try to explore the API, my API returns that I'm not authenticated. Chrome headers show my response looks like this:

Remote Address:127.0.0.1:3000
Request URL:http://api.rails-app.dev:3000/users/me
Request Method:GET
Status Code:401 Unauthorized
Request Headersview source
Accept:application/json
Accept-Encoding:gzip, deflate, sdch
Accept-Language:en-US,en;q=0.8
Connection:keep-alive
Content-Type:application/json
Cookie:_Swyp_session=eUJVWkFkVDBsY0JUM2lsUlJmK1l3ekZSZkYzWkJob0RtdnZCeS9WVnRzMzYrSWZWY3IrRHk3OG5CWGRoblE1eWdCaEJSZEtQYU8rSk1yci9CLzJsZEFGQWNLYVBia01mbXNBeGViZkxkbWlhc3pDVXg5K0FFa2lJbzFMVTAvTlZKbVNOcmwzLzBwNHJaVVJUT2U0eVZRPT0tLWMwYkZDRVZjT3I0VjYwdzVXY05CakE9PQ%3D%3D--ce1311b8a602a03f272492ae3cdd2b9576bacced
Host:api.rails-app.dev:3000
Referer:http://api.rails-app.dev:3000/swagger
User-Agent:Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Ubuntu Chromium/39.0.2171.65 Chrome/39.0.2171.65 Safari/537.36

The swaggerApi object doesn't appear to be including any authorization handlers either.

SwaggerApi {url: "http://api.rails-app.dev:3000/swagger_doc", debug: false, basePath: "http://api.rails-app.dev:3000/swagger_doc", authorizations: null, authorizationScheme: null…}

My Gemfile.lock looks like this:

    grape (0.10.1)
      activesupport
      builder
      hashie (>= 2.1.0)
      multi_json (>= 1.3.2)
      multi_xml (>= 0.5.2)
      rack (>= 1.3.0)
      rack-accept
      rack-mount
      virtus (>= 1.0.0)
    grape-entity (0.4.5)
      activesupport
      multi_json (>= 1.3.2)
    grape-swagger (0.10.1)
      grape (>= 0.8.0)
      grape-entity
    grape-swagger-rails (0.1.0)
      grape-swagger (>= 0.7.2)
      railties (>= 3.2.12)

I looked around in the code to try to debug this myself but I couldn't quite figure out where the options were being read.

There are ways of excluding some files from Analysis.

https://docs.codeclimate.com/docs/excluding-files-and-folders

Excluding some files would focus the analysis, and make the final score more informative.

I have this gem installed in my app, and when I visit the documentation page this is what I get.

In the console is evidenced that the web page is not being able to load the css and js needed for it to work. Any ideas on why I'm getting this?

I'm using:

• Rails 4.2.6
• Grape, Win Bouncer, Doorkeeper

How can I pre-fill API key for logged in user for swagger UI? The only way I figured out how to get the current token is by creating on separate rails app as an OauthClient. However, for convenience and in production I would like to prefill the api key in swagger UI. Or how can a logged in user get the api key easily?

wine_bouncer.rb:

WineBouncer.configure do |config|
  config.auth_strategy = :swagger

  config.define_resource_owner do
    User.find(doorkeeper_access_token.resource_owner_id) if doorkeeper_access_token
  end
end

swagger.rb:

GrapeSwaggerRails.options.url      = '/api/mobile/swagger_doc.json'
GrapeSwaggerRails.options.app_url  = 'https://www.domain.com'
GrapeSwaggerRails.options.api_key_name = 'access_token'
GrapeSwaggerRails.options.api_key_type = 'query'

I wanna to custom style for swagger,

I copy application.css from grape-swagger-rails and place into myapp/app/assets/stylesheets/grape_swagger_rails.

/*
*= require reset
*= require screen
*= require_self
*/

ul {
  margin-left: 10px;
}

but it throw error:

couldn't find file 'reset'

I have some inputs that I'd like to pre-fill when a user is logged in like the user's CLIENT_TOEKN.

But I can't figure out how to do it.

I am using a grape api and can render the attachment in my code just fine. However it does not appear to work in the swagger ui. There is a download link which opens a file that can not be displayed properly.

We both use createObjectURL with a blob, however the response type in swagger ui is a string while I am using an arraybuffer. When I change my code to use a string instead I get the same behavior as swagger ui.

Is there a way to specify the response type to be array buffer instead?

This is a very minor issue.

Would ruby-grape considering detaching the fork from BrandyMint? It's a very minor ux issue because its constantly comparing the master of the two repos. I'm very grateful for BrandyMint's contributions and would support adding the original repo to the README.

To detach the fork and turn it into a standalone repository on GitHub, contact GitHub support.

https://help.github.com/articles/why-are-my-contributions-not-showing-up-on-my-profile/
https://github.com/contact

How do I change heading in swagger

In swagger UI all the headings are having default messages like "user: Operations about user". Is there any way that I can customize the heading?

Swagger-ui supports multiple languages via translations. This is currently ignored.

the <li> and table of content without no Indentation

Swagger-ui has CSS for print media. It's currently ignored.