swagger-api / swagger-api/swagger-ui
Standalone Swagger UI guide for non-node users
@shockey is already working on this.
Since Jan 15, 2019.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Complicated 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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.