sway

A library that simplifies Swagger integrations.

  • sway

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
sway
190622.0.65 years ago9 years agoMinified + gzip package size for sway in KB

Readme

A library that simplifies Swaggerswagger integrations. This library handles the minutiae of loading Swagger documents (local and remote), resolving references (local, remote), building an object model and providing you with a rich set of APIs for things like Swagger document validation, request/response validation, etc. For more details on the available APIs, please view the API Documentation.
Sway will always be built around the latest stable release of Swagger, which happens to be version 2.0 right now. This means that its APIs and object model will be specific to that version of Swagger and supporting any other versions of Swagger will require a conversion step prior to using Sway.

Project Badges

  • Build status: Build Status
  • Dependencies: Dependencies
  • Developer dependencies: Dev Dependencies
  • Downloads: NPM Downloads Per Month
  • Gitter: Join the chat at https://gitter.im/apigee-127/sway
  • License: License
  • Version: NPM Version

Installation

sway is available for both Node.js and the browser. Installation instructions for each environment are below.

Browser

sway binaries for the browser are available in the dist/ directory:

Note: I realize these binaries are big and I'm working on making them smaller. Unfortunately, some of this is out of my control without rewriting some of the core features provided by third-party libraries currently contributing to the size issue.
Of course, these links are for the master builds so feel free to download from the release of your choice. Once you've gotten them downloaded, to use the standalone binaries, your HTML include might look like this:
<!-- ... -->
<script src="sway.js"></script>
<!-- ... -->

Node.js

Installation for Node.js applications can be done via NPMnpm.
npm install sway --save

Documentation

The documentation for this project can be found here: /docs/README
Of course, if you just want a quick link to the API documentation, that would be here:/docs/API.md

Contributing

This project uses Gulpgulp 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.