This topic briefly describes the relevant Node.js modules on which a swagger project depends.
The swagger npm module provides everything you need to create new projects, including the Swagger editor, Swagger Tools middleware, sample project skeletons, and the swagger command-line tools.
For installation instructions, see "Installation".
The main source of documentation for the swagger module and related components is in the swagger-node repository on GitHub.
The swagger command-line tools are installed with swagger.
swagger command-line reference
A basic, "hello world" swagger project. This project automatically cloned when you create a new swagger project by executing swagger project create. Skeleton projects are implemented for specific API frameworks, such as express, restify, or others.
See the swagger "Quick start" to see how easy it is to get a new swagger API project up and running.
The Swagger Editor lets you design your API specification and interactively preview its documentation for your swagger API project.
Standard npm install. Installed with swagger.
See "Swagger Editor" on GitHub.
Middleware for Node.js including Message Validation, Authorization and Routing.
Standard npm install. Installed with swagger.
See the swagger-tools README on GitHub.
Swagger tools provides these middleware components. They provide services for message validation, authorization, and routing.
- swagger-metadata
- swagger-router
- swagger-validator