sway/README.md

2.6 KiB

An API for interacting with Swagger documents.

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/swagger-core-api
  • License: License
  • Version: NPM Version

Installation

swagger-core-api is available for both Node.js and the browser. Installation instructions for each environment are below.

Browser

Installation for browser applications can be done via Bower or by downloading a standalone binary.

Using Bower

bower install swagger-core-api --save

Standalone Binaries

The standalone binaries come in two flavors:

Node.js

Installation for Node.js applications can be done via NPM.

npm install swagger-core-api --save

Documentation

The documentation for this project can be found here: https://github.com/apigee-127/swagger-core-api/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/swagger-core-api/blob/master/docs/API.md

Contributing

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.