question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Standalone Swagger UI guide for non-node users

See original GitHub issue

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.

Issue Analytics

  • State:open
  • Created 5 years ago
  • Reactions:12
  • Comments:8

github_iconTop GitHub Comments

21reactions
anocommented, Jul 7, 2019

That’s a common problem with software development process these days, unnecessary complexity.

Standalone Install:

Hope that helps

4reactions
daniel-kuncommented, Apr 7, 2019

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.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Installation - Swagger Documentation
Installation. Distribution channels. NPM Registry. We publish two modules to npm: swagger-ui and swagger-ui-dist . swagger-ui is meant for consumption by ...
Read more >
Configuration - Swagger Documentation
Swagger UI accepts configuration parameters in four locations. ... The ID of a DOM element inside which SwaggerUI will put its user interface....
Read more >
About Swagger Specification | Documentation
Available endpoints ( /users ) and operations on each endpoint ( GET /users ... Swagger UI – renders OpenAPI definitions as interactive documentation....
Read more >
Plug points - Swagger Documentation
While using the Standalone Preset the SwaggerUI logo is rendered in the Top Bar. The logo can be exchanged by replacing the Logo...
Read more >
REST API Documentation Tool | Swagger UI
This latest release enables users to use the Swagger Editor to describe OAS 3.0 APIs, and the Swagger UI to visual and automatically...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found