https://github.com/sensiblewood/swaggerui-webpack-boilerplate

Boilerplate for spinning up local Swagger UI server, orchestrated through Webpack
https://github.com/sensiblewood/swaggerui-webpack-boilerplate

api openapi openapi3 swagger-ui webpack

Last synced: 22 days ago
JSON representation

Boilerplate for spinning up local Swagger UI server, orchestrated through Webpack

• Host: GitHub
• URL: https://github.com/sensiblewood/swaggerui-webpack-boilerplate
• Owner: SensibleWood
• Created: 2018-10-02T09:41:56.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2021-02-15T12:54:46.000Z (almost 4 years ago)
• Last Synced: 2024-10-05T18:20:18.689Z (about 1 month ago)
• Topics: api, openapi, openapi3, swagger-ui, webpack
• Language: JavaScript
• Size: 181 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Overview

===

This is boilerplate project for running Swagger UI with Webpack. It exists because:

* I wanted an easy way of slamming multiple API specifications into a Swagger UI-based project and running it locally.

* I didn't wanted to manually change the Javascript every time I added an API specification.

* Using NPM/Webpack means my dependencies can be kept up-to-date easily.

Sure there's other ways of doing this, but still...

~There's also a Redoc page - although this is CDN-based as I am lazy.~ I removed the Redoc version for the time being.

Usage

===

To use this project clone and cd into it then:

```bash

npm i

cp [your Swagger/OpenAPI specifications as YAML] src/specs

npm run dev

```

:thumbsup:

Improvements

===

* [ ] Parameterise API specification document name.

* [ ] Refactor `scripts/rewrite-urls.js` as a Webpack plugin.