A library that simplifies Swagger integrations.
- Build status:
- Dependencies:
- Developer dependencies:
- Downloads:
- Gitter:
- License:
- Version:
Up until 1.0.0, the API is unstable and can change without warning. While we will do our best to ensure this does
not happen, as we begin to use sway we may run into situations where changing the API is required.
sway is available for both Node.js and the browser. Installation instructions for each environment are below.
Installation for browser applications can be done via Bower or by downloading a standalone binary.
bower install sway --save
The standalone binaries come in two flavors:
- sway-standalone.js: 4,048kb, full source and source maps
- sway-standalone-min.js: 592kb, minified, compressed and no source map
Note: I realize these browser binaries are not small. For the most part, this is due to a library we are using for creating mock/sample parameters/responses. json-schema-faker uses faker.js which ships with a number of locales, which we currently are not using. Attempts to package sway in a way to make it smaller led to a json-schema-faker packaging issue that is unresolved. In the future, if we were to expose this local support we would need these locales in the binary anyways so at the end of the day I've marked this as unavoidable.
Installation for Node.js applications can be done via NPM.
npm install sway --save
The documentation for this project can be found here: https://github.com/apigee-127/sway/blob/master/docs/README.md Of course, if you just want a quick link to the API documentation, that would be here: https://github.com/apigee-127/sway/blob/master/docs/API.md
This project uses Gulp for building so npm install -g gulp once you clone this project. Running gulp in the
project root will lint check the source code and run the unit tests.