Standalone Swagger UI guide for non-node users
See original GitHub issueComplicated install?
I know it will sound lame, but when I tested Swagger UI like two years ago I copied some static content, configured it a bit and was done. Today I’m lost in the installation documentation, not knowing where to start, Download button is never downloading but sending me to another page, etc.
When I tried dev environment from this page https://swagger.io/docs/open-source-tools/swagger-ui/development/setting-up/ I ended up on gyp error (I guess I have to install that Python 2.x).
When I get finally here https://www.npmjs.com/package/swagger-ui it suggests npm install ...
(and one has to know the site to find it). But that command alone does not help.
When I try https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/installation.md I’m lost right away.
I feel like I have to be node/npm master. I casually do Angular, but I have no idea how to get Swagger up and running in some standalone mode. There seems to be some hope on stackoverflow, but I remember easier start with Swagger UI before.
How can we help?
Step by step guide without assuming that I know node/npm would be welcome. If I create REST API I don’t have to be well oriented in node ecosystem. I’m surprised that integration Swagger into Spring Boot is currently easier than to run it standalone with some specification as a parameter.
Issue Analytics
- State:
- Created 5 years ago
- Reactions:12
- Comments:8
Top GitHub Comments
That’s a common problem with software development process these days, unnecessary complexity.
Standalone Install:
Hope that helps
Just adding my 2c, after I abandoned swagger ui out of frustration: I find the installation instructions incomprehensible, too, although I am familiar with node, npm, etc.
I was looking for a simple™ way to generate a standalone webpage with swagger ui, but I was not able to get this to work, since the docs are heading in what feels like 10 directions, but don’t follow even one environment from start to finish.
My use case is generating and publishing docs on the web for an API that is served on a device, so there is no cloud environment that I control. So just dropping a folder with html/js/css on a webserver was my goal.