Swagger Editor offline installation

Question

Our company is using swagger to document their API's, currently a couple of developers are using the online swagger editor on their PC's.

I want to move this piece of the design process into our standard development environment, which is in a walled garden without internet access.

How do I go about installing npm and the swagger editor in an offline environment?

There are options to use either RHEL or Windows machines, although Windows is preferable as developers have local admin rights

score 34 · Answer 1 · answered Nov 07 '17 at 17:37

34

git clone https://github.com/swagger-api/swagger-editor.git
cd swagger-editor
npm install
npm run build
npm start

And it will works in your Intranet OK.

answered Nov 07 '17 at 17:37

Akzhan Abdulin

Doesn't the above require internet access? – druidoodle Nov 07 '17 at 17:48
No. It doesn't require Internet access after bootstrapping. – Akzhan Abdulin Nov 08 '17 at 10:56
This is actually the best solution. As a matter of fact I tried this with Node 11.2.0 and it didn't work straight away, but then switched to 6.14.0 and it worked like a charm! – Hugo Tavares Mar 08 '19 at 14:27

score 25 · Accepted Answer · answered Nov 07 '17 at 17:38

25

npm is not required, you can download the compiled files from the Swagger Editor repository:

and open index.html locally (from the file system) or put the files onto a web server in your network.

answered Nov 07 '17 at 17:38

Helen

yes, it works as static file too. With some limitations but I don't remember 'em. – Akzhan Abdulin Nov 07 '17 at 17:40
Thanks - I will try this now. Does it have the full capabilities when running in this way? – druidoodle Nov 07 '17 at 17:49
1

@druidoodle Yes - autocompletion, syntax checking, UI render, try it out, etc. – Helen Nov 07 '17 at 17:59
@Helen - thanks for this. It works, although not in Chrome. I think there's some issue in Chrome of accessing local storage for local files, I'll research that myself. – druidoodle Nov 07 '17 at 18:08
@druidoodle: try running Chrome with [`--allow-file-access-from-files`](https://stackoverflow.com/q/18586921/113116). Or better yet, run a local web server (e.g. IIS if you use Windows) and run Editor from there. – Helen Nov 07 '17 at 18:16

score 1 · Answer 3 · answered Feb 01 '20 at 23:25

1

With one command with npm/npx:

npx swagger-editor-binary

answered Feb 01 '20 at 23:25

user3352495

Yufeng Lan · Answer 4 · 2020-01-14T01:16:40.440

Download the one of the source releases from swagger-editor's github page (click releases link on the page)
unzip the downloaded source release zip/tar file.
cd into the extracted source dir, type 'npm install' (or if you have some npm mirror module installed, such as cnpm, use 'cnpm install' instead)
Use a browser to open index.html file in the source dir. Or, follow official guide the 'Setup with http-server module from GitHub' section to serve from a local static web server.

PS. You don't need to build the source code unless you want to contribute as written in the 'Contribute' section of the official document.

4 Answers4