Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

The purpose of Swagger Tools (swagger-tools) is to provide some useful Swagger tooling written in/for Node.js. Use the links below to get specific documentation about the provided APIs and tools:

  • API: The JavaScript API for interacting with Swagger documents
  • Middleware: Connect middleware using Swagger information for various things (Ex: Request validation, routing, ...)

Installation

As of right now, Swagger Tools is only available for Node.js. (The reason this is mentioned is because we will eventually make a browser distribution for the applicable parts of the project. See #22.)

If you want to use the Swagger Tools APIs and middleware, install Swagger Tools into your project like so:

npm install swagger-tools --save

Installation globally right now doesn't make much sense but when the eventual CLI executables are available, you'd install Swagger Tools globally like this:

npm install -g swagger-tools

At this point, you're ready for the Quick Start.