| 1 | ## swagger modules and dependencies
|
| 2 |
|
| 3 | This topic briefly describes the relevant Node.js modules on which a swagger project depends.
|
| 4 |
|
| 5 | * [swagger](#swagger)
|
| 6 | * [skeleton](#skeleton)
|
| 7 | * [swagger-editor](#swagger-editor)
|
| 8 | * [swagger-tools](#swagger-tools)
|
| 9 |
|
| 10 | ###<a ref='swagger'></a>swagger
|
| 11 |
|
| 12 | 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.
|
| 13 |
|
| 14 | ####Installation
|
| 15 | For installation instructions, see "[Installation](./install.md)".
|
| 16 |
|
| 17 | ####Documentation
|
| 18 |
|
| 19 | The main source of documentation for the swagger module and related components is in the swagger-node repository on GitHub.
|
| 20 |
|
| 21 | ####Installation
|
| 22 |
|
| 23 | The swagger command-line tools are installed with swagger.
|
| 24 |
|
| 25 | #### Documentation
|
| 26 |
|
| 27 | [swagger command-line reference](./cli.md)
|
| 28 |
|
| 29 |
|
| 30 | ### <a ref='skeleton'></a>skeleton
|
| 31 |
|
| 32 | 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.
|
| 33 |
|
| 34 | #### Documentation
|
| 35 |
|
| 36 | See the swagger "[Quick start](./quick-start.md)" to see how easy it is to get a new swagger API project up and running.
|
| 37 |
|
| 38 | ### <a ref='swagger-editor'></a>swagger-editor
|
| 39 |
|
| 40 | The Swagger Editor lets you design your API specification and interactively preview its documentation for your swagger API project.
|
| 41 |
|
| 42 | ####Installation
|
| 43 |
|
| 44 | Standard npm install. Installed with swagger.
|
| 45 |
|
| 46 | ####Documentation
|
| 47 |
|
| 48 | See "[Swagger Editor](https://github.com/swagger-api/swagger-editor)" on GitHub.
|
| 49 |
|
| 50 | ### <a ref='swagger-tools'></a>swagger-tools
|
| 51 |
|
| 52 | Middleware for Node.js including Message Validation, Authorization and Routing.
|
| 53 |
|
| 54 | ####Installation
|
| 55 |
|
| 56 | Standard npm install. Installed with swagger.
|
| 57 |
|
| 58 | ####Documentation
|
| 59 |
|
| 60 | See the `swagger-tools` [README](https://github.com/apigee-127/swagger-tools) on GitHub.
|
| 61 |
|
| 62 |
|
| 63 | #### Swagger Tools middleware components
|
| 64 |
|
| 65 | Swagger tools provides these middleware components. They provide services for message validation, authorization, and routing.
|
| 66 |
|
| 67 | * swagger-metadata
|
| 68 | * swagger-router
|
| 69 | * swagger-validator
|