Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moon0326/swagger-ui-watcher
Automatically refreshes Swagger UI on Swagger file changes
https://github.com/moon0326/swagger-ui-watcher
multifile-swagger swagger watch
Last synced: about 2 months ago
JSON representation
Automatically refreshes Swagger UI on Swagger file changes
- Host: GitHub
- URL: https://github.com/moon0326/swagger-ui-watcher
- Owner: moon0326
- Created: 2017-07-31T08:28:40.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-25T07:03:29.000Z (9 months ago)
- Last Synced: 2024-04-24T16:24:19.741Z (8 months ago)
- Topics: multifile-swagger, swagger, watch
- Language: JavaScript
- Homepage:
- Size: 3.03 MB
- Stars: 168
- Watchers: 7
- Forks: 36
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-tools - swagger-ui-watcher
README
# Swagger UI Watcher
Swagger UI Watcher detects changes in your local Swagger files and reload Swagger UI in your browser to give you fluid workflow. It is primarily developed to work with multiple Swagger files using \$ref.
## Why?
- Using online Swagger Editor is annoying. You have to copy and paste your Swagger files back and forth.
- Relative and local system \$ref do not work with online Swagger Editor v3
- Manually creating bundle from multiple Swagger files after each update is impractical and tiresome.
- Using my editor/ide of choice is awesome.
## Installation
| Version | Swagger Version |
| ------- | --------------- |
| 1.0.10 | 2 |
| >=2.0 | 3 |
```
npm install swagger-ui-watcher -g
```
## Usage
For watching the changes in target directory, following command is used
```
swagger-ui-watcher ./main-swagger-file.json
```
### Additional Options
| Command line argument | Description |
| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| -p --port | Default is 8000 |
| -h --host | Defaults to 127.0.0.1 |
| --no-open | Do not open the view page in the default browser |
| -c --config | JSON file containing any of the [Swagger UI options](https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md). Example: `{"withCredentials": true}` |
| -b --bundle | Create bundle at the specified location |
| -i --ignore | File or path omitted from watching. Supports globbing |
For creating the bundled file, provide the optional argument `bundle`
```
swagger-ui-watcher ./main-swagger-file.json --bundle=./bundled.json
```
Click the image to see it in action
[](https://www.youtube.com/embed/ejBS75q3ouo?autoplay=1)
## Do What You Want to Public License
```
DO WHAT YOU WANT TO PUBLIC LICENSE
Version 3, January 2012
Copyright (C) 2012 Ryan Thompson
Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.
DO WHAT YOU WANT TO PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. You just DO WHAT YOU WANT TO.
```