0 : error http://localhost:3000/swagger_doc/swagger_doc.json

[reiz]

I have some issues with this project. It doesn't work very well with swagger-ui. I am getting wrong urls from grape-swagger. I posted the bug report here:

swagger-api/swagger-ui#130 (comment)

I appreciate any kind of help.

[reiz]

ping.

[tim-vandecasteele]

What fork of swagger-ui are you using? It's been a while since I've used the latest swagger-ui. It should certainly work with the vasco branch in https://github.com/tim-vandecasteele/swagger-ui

[reiz]

Nope. Same error with that fork. My input:

http://localhost:3000/v1/swagger_doc.json

And the UI tries to fetch:

http://localhost:3000/swagger_doc/swagger_doc.json

For what reason ever. Looks like a strange string replacement bug.

[tim-vandecasteele]

Do you still face this issue if you set :hide_documentation_path => true ?

[reiz]

That helped. Now it's a different error. My input is not this here:

http://localhost:3000/api/v1/swagger_doc.json

And swagger ui is calling:

http://localhost:3000/api/swagger_doc/users.json

grape-swagger code looks like that:

add_swagger_documentation :base_path => "http://localhost:3000/api", 
                                :api_version => "v1",
                                :markdown => true, 
                                :hide_documentation_path => true

[reiz]

Here is the response for "http://localhost:3000/api/v1/swagger_doc.json" :

{
 apiVersion: "v1"
 swaggerVersion: "1.1" 
 basePath: "http://localhost:3000/api"
 operations: [ ]
-apis: [
-{
path: "/swagger_doc/products.{format}"
}
-{
path: "/swagger_doc/services.{format}"
}
-{
path: "/swagger_doc/projects.{format}"
}
-{
path: "/swagger_doc/sessions.{format}"
}
-{
path: "/swagger_doc/me.{format}"
}
-{
path: "/swagger_doc/users.{format}"
}
]
}

[tim-vandecasteele]

My guess is you're mounting it on the v1 version.

Could you try with :mount_path => '/v1/swagger_doc'

[reiz]

with that mount path above it didn't work. In the routes.rb I have this here:

mount V1::Versioneye::API => '/api'

[tim-vandecasteele]

I guess it works if you're not using a version?

[reiz]

If my mapping looks like this:

add_swagger_documentation :base_path => "http://localhost:3000/api", 
                                :markdown => true, 
                                :hide_documentation_path => true

Than with this input "http://localhost:3000/api/v1/swagger_doc.json" the UI return this error:

0 : error http://localhost:3000/api/swagger_doc/users.json

Of course that is wrong, because the version "v1" is missing in the url. It should be "http://localhost:3000/api/v1/swagger_doc/users.json".

[reiz]

And if I leave out the version in the json the version is set to "0.1"

{
apiVersion: "0.1"
swaggerVersion: "1.1"
basePath: "http://localhost:3000/api"
operations: [ ]
-apis: [
-{
path: "/swagger_doc/products.{format}"
}
-{
path: "/swagger_doc/services.{format}"
}
-{
path: "/swagger_doc/projects.{format}"
}
-{
path: "/swagger_doc/sessions.{format}"
}
-{
path: "/swagger_doc/me.{format}"
}
-{
path: "/swagger_doc/users.{format}"
}
]
}

[tim-vandecasteele]

Mmm, this seems to be an issue due to the fact that you're mounting the documentation in an API versioned by path.

I must honestly say that I haven't used grape swagger yet with a versioned API, so there could be multiple issues with it (there have already been several pull requests, so for sure something is working).

Anyway, I fixed the bug in commit 23454cf

[reiz]

OK. I will try it. Thanks.

[reiz]

Jip. The bug is fixed. Many Thanks.