search

jensoleg / swagger-ui

Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
http://swagger.io
Other
1.13k stars 310 forks source link

Cannot install and use #63

Open nicola883 opened 8 years ago

nicola883 commented 8 years ago

I have downloaded the files but I am not able to get all working. I don't see any information to install the code. I have a swagger-ui running well and I have tried to take the code from your dist folder to replace the standard swagger-ui, but I get a not found error on javascript (http://localhost/swagger.json 404 (Not Found)), that is normal because all is located in a subdirectory. Is there some place to configure the paths? Is there another way to install? Many thanks for your help and for this important project.

davidkeaveny commented 8 years ago

I had this issue as well; I was deploying the dist folder into a subfolder in my web application, but the URL to the Swagger definition file is calculated as being the root of the web application, rather than being local to the index.html.

In the interest of just getting things done, I copied my Swagger definition to the expected location, and it all works beautifully. Now I can get on with serious stuff, like complaining about some of the JS statements in index.html not being terminated with semi-colons consistently :-). Or building the actual API!

zh-wowtv commented 8 years ago

Any document on how to use it?

S33G commented 8 years ago

Would like to see some documentation also!

dgreda commented 8 years ago

Hello. I'm missing documentation on usage too. I checked the Dockerfile to see that I can build the container and run it, but afterwards I couldn't connect to it to display the UI. Also it would be good to be able to specify path to swagger json file etc. I think many people will feel clueless about this library if there is nothing about installation and usage. Project seems to be really cool and I would be really happy seeing it going forward :) Please help by providing setup guide.

SimonVillage commented 6 years ago

Still missing a documentation!

codewithrajranjan commented 5 years ago

Why haven't you provided a installation guide. Its frustrating

shubh453 commented 5 years ago

Please provide a documentation with installation guide so that it'll be easier to replace the default swagger ui with this one.