Git Product home page Git Product logo

swagger-ui-electron's Introduction

Swagger UI Electron

Small electron wrapper around the Swagger UI Dist package to serve it locally.

This uses the latest swagger-ui-dist as published by the Swagger Team, so it should always be up-to-date.

Just re-run the installation steps to update for any new releases.

Installation

The project must be built from source, so requires NodeJS to be installed.

The npm build script handles the work

$ npm run build

Copy the system compatible executable from the out folder to your desired install location.

OSX

Example to copy an Arm Mac Bundle

$ cp -R ./out/swagger-ui-electron-darwin-arm64/swagger-ui-electron.app ~/Applications

Windows

On Windows you can run the Squirrel Installer located in out/make/squirrel.windows/x64/swagger-ui-election-X.X.X Setup.exe which installs to the AppData folder location %LOCALAPPDATA%\SwaggerUi which can be then pinned to start as required.

See https://www.electronforge.io/config/makers/squirrel.windows

Or just copy the built app to Program Files etc as required from out/swagger-ui-electron-win32-x64

Usage

By default, it loads the example petstore swagger spec, change the URL to point to the desired API spec and press explore to load it.

img.png

Built With

swagger-ui-electron's People

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.