https://github.com/asaday/swaggereui
Swagger UI with Electron
https://github.com/asaday/swaggereui
Last synced: about 2 months ago
JSON representation
Swagger UI with Electron
- Host: GitHub
- URL: https://github.com/asaday/swaggereui
- Owner: asaday
- License: mit
- Created: 2015-12-29T08:46:16.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-12-29T08:47:48.000Z (over 10 years ago)
- Last Synced: 2025-03-02T11:17:56.159Z (over 1 year ago)
- Language: CSS
- Size: 289 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Swagger UI with Electron
This is Swagger UI with Electron, can load local json/yaml swagger schema file. Standalone.
[Swagger](http://swagger.io/)
[Swagger UI](https://github.com/swagger-api/swagger-ui)
## Install
This project use node.js.
`brew install node`
at first,install electron
```
$npm -g install electron-prebuilt
```
clone this project,and go to this project local path.
```
$git clone https://github.com/asaday/swaggerEUI
$cd swaggerEUI
```
install npm libs
```
$npm install
```
show sample
```
$electron . sample/sample.yaml
```
## Usage
```
$ electron . -h
usage: swaggereui [-h] [-a ADD] [file]
Positional arguments:
file Swagger schema json or yaml
Optional arguments:
-h, --help Show this help message and exit.
-a ADD, --add ADD add header json
```
if you want to add headers (for example auth token),
prepare headers by json file.
```
{
"Authorization": "Bearer YOUR_SERVER_TOKEN"
}
```
and use -a option
```
$electron . sample/sample.yaml -a sample/header.json
```