A library that simplifies Swagger integrations.
Перейти к файлу
Jeremy Whitlock 9dc7e0191a Better documented the validator response
Fixes #12
2015-08-12 10:15:06 -06:00
browser Better documented the validator response 2015-08-12 10:15:06 -06:00
docs Better documented the validator response 2015-08-12 10:15:06 -06:00
lib Better documented the validator response 2015-08-12 10:15:06 -06:00
samples/2.0 First pass at adding APIs to get sample/mock values 2015-06-05 16:42:04 -06:00
test Namespaced the options passed to json-refs 2015-08-12 09:54:50 -06:00
.editorconfig Initial project structure. 2015-04-09 19:24:39 -06:00
.eslintrc Updated dependencies 2015-08-03 13:37:23 -06:00
.gitignore First pass at the Operation and Parameter types 2015-05-26 11:45:53 -06:00
.travis.yml Added support for loading a Swagger document 2015-05-14 16:45:17 -06:00
LICENSE Initial project structure. 2015-04-09 19:24:39 -06:00
README.md Namespaced the options passed to json-refs 2015-08-12 09:54:50 -06:00
RELEASE_NOTES.md Added support for loading a Swagger document 2015-05-14 16:45:17 -06:00
bower.json Updated dependencies 2015-08-03 13:37:23 -06:00
gulpfile.js Fixed Gulp build process for browser testing 2015-08-03 17:59:52 -06:00
index.js Namespaced the options passed to json-refs 2015-08-12 09:54:50 -06:00
package.json Updated dependencies 2015-08-03 13:37:23 -06:00

README.md

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.