https://github.com/cloudstek/swagger-ui-preview

Easy way to fire up swagger-ui and preview your swag
https://github.com/cloudstek/swagger-ui-preview

api-documentation openapi swagger swagger-ui

Last synced: 10 days ago
JSON representation

Easy way to fire up swagger-ui and preview your swag

• Host: GitHub
• URL: https://github.com/cloudstek/swagger-ui-preview
• Owner: Cloudstek
• License: bsd-2-clause
• Created: 2017-06-25T20:11:03.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-07-19T15:02:15.000Z (over 7 years ago)
• Last Synced: 2024-10-01T11:37:45.861Z (about 2 months ago)
• Topics: api-documentation, openapi, swagger, swagger-ui
• Language: JavaScript
• Homepage:
• Size: 29.3 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Swagger UI Preview

Easiest way to preview your swagger files with swagger-ui. Uses [swagger-parser](https://www.npmjs.com/package/swagger-parser) under the hood to parse swagger files and feed them to swagger-ui.

## Installation

```bash

npm install -g swagger-ui-preview

```

## Usage

Run swagger-ui-preview with the path to your swagger file (JSON or YAML) and point your browser to http://localhost:8080.

```bash

swagger-ui-preview /path/to/your/swagger_file.yml

```

In case you want to run swagger-ui-preview on a different port:

```bash

swagger-ui-preview -p 3000 /path/to/your/swagger_file.yml

```

## Related packages

* [swagger-parser](https://www.npmjs.com/package/swagger-parser)

* [swagger-ui](https://www.npmjs.com/package/swagger-ui)