{"_id":"swagger-express","_rev":"33-6d68b5a56ff993c3daa8ac414df37c10","name":"swagger-express","description":"Document your express rest api by jsDoc or yaml.","dist-tags":{"latest":"1.0.5"},"versions":{"1.0.0":{"name":"swagger-express","description":"Document your express rest api by jsDoc or yaml.","version":"1.0.0","author":{"name":"fliptoo","email":"fliptoo.studio@gmail.com"},"main":"./index","dependencies":{"express":"*","underscore":"*","doctrine":"*","js-yaml":"*"},"devDependencies":{"jade":"*"},"keywords":["swagger","swagger-ui","express","api","jsdoc","yml","yaml","restful"],"repository":{"type":"git","url":"git://github.com/fliptoo/swagger-express"},"_id":"swagger-express@1.0.0","dist":{"shasum":"4972cef9eec67ca415a919b71911bbc7a9d6b6d3","tarball":"https://registry.npmjs.org/swagger-express/-/swagger-express-1.0.0.tgz","integrity":"sha512-sbZGjjU7z5bxuVG5c9ym5w6oI3KsDY/0nvCP4kzWpSNNTRgT0roNEZ6caA0NVWpJSPr890jeqAXYnnq59LF4SQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIG9+iIKzq//+Cw1oqmzWBd4KehdVD5Vv8RKUR9XZjTdrAiBVk0D/ojLeqGTq6b75ydDGtg56X4aMAebeR61+//lAtQ=="}]},"_npmVersion":"1.1.66","_npmUser":{"name":"fliptoo","email":"fliptoo.studio@gmail.com"},"maintainers":[{"name":"fliptoo","email":"fliptoo.studio@gmail.com"}]},"1.0.1":{"name":"swagger-express","description":"Document your express rest api by jsDoc or yaml.","version":"1.0.1","author":{"name":"fliptoo","email":"fliptoo.studio@gmail.com"},"main":"./index","dependencies":{"express":"*","underscore":"*","doctrine":"*","js-yaml":"*","async":"~0.2.7"},"devDependencies":{"jade":"*","jshint":"*"},"scripts":{"test":"jshint --config jshint.cfg $(find . -name *.js | grep -v './node_modules')"},"keywords":["swagger","swagger-ui","express","api","jsdoc","yml","yaml","restful"],"repository":{"type":"git","url":"git://github.com/fliptoo/swagger-express"},"_id":"swagger-express@1.0.1","dist":{"shasum":"994534c291d5ba6ad63a91fb67d01432acd93f6c","tarball":"https://registry.npmjs.org/swagger-express/-/swagger-express-1.0.1.tgz","integrity":"sha512-bx/RtJSWzCQubXOmVdmYxp8HbacPFT4X5QJCIav/SmZCtnKQ0G4W3TsApEO6zwj6Dgv0YWy61B16xdUMbxgoLQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDDlp8doaf/FHu7s7NcAYEGapKuelTfkxVhsxRCFuU3FQIgLAu0CZSJB42Qjk1HBjJL27aU/yz/nGTlegBI0zBl50U="}]},"_npmVersion":"1.1.66","_npmUser":{"name":"fliptoo","email":"fliptoo.studio@gmail.com"},"maintainers":[{"name":"fliptoo","email":"fliptoo.studio@gmail.com"}]},"1.0.2":{"name":"swagger-express","description":"Document your express rest api by jsDoc or yaml.","version":"1.0.2","author":{"name":"fliptoo","email":"fliptoo.studio@gmail.com"},"main":"./index","dependencies":{"express":"*","underscore":"*","doctrine":"*","js-yaml":"~2.1.0","async":"~0.2.7"},"devDependencies":{"jade":"*","jshint":"*"},"scripts":{"test":"jshint --config jshint.cfg $(find . -name *.js | grep -v './node_modules')"},"keywords":["swagger","swagger-ui","express","api","jsdoc","yml","yaml","restful"],"repository":{"type":"git","url":"git://github.com/fliptoo/swagger-express"},"bugs":{"url":"https://github.com/fliptoo/swagger-express/issues"},"_id":"swagger-express@1.0.2","dist":{"shasum":"dd46676aa9dfc8843be92ca4d9f2df2f815921cc","tarball":"https://registry.npmjs.org/swagger-express/-/swagger-express-1.0.2.tgz","integrity":"sha512-yVQ+t4yt6pIZVRcE4zPPXI2bmiWRc+Ib+FV+lJfci1RG2jTRc1Ja76F376ho1+7z55c/J0aR27qeYD+DT1irGA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDg6VdcnotuhoRefCI3iZBpbuhJj6KDr2+h3gnR3CB75QIhAPLSgZho9iJXW+ryw4gEDAl5oGEVIAvuuPqcgoPB7XIi"}]},"_from":".","_npmVersion":"1.3.11","_npmUser":{"name":"fliptoo","email":"fliptoo.studio@gmail.com"},"maintainers":[{"name":"fliptoo","email":"fliptoo.studio@gmail.com"}]},"1.0.4":{"name":"swagger-express","description":"Document your express rest api by jsDoc or yaml.","version":"1.0.4","author":{"name":"fliptoo","email":"fliptoo.studio@gmail.com"},"main":"./index","dependencies":{"express":"*","underscore":"*","doctrine":"*","js-yaml":"~2.1.0","async":"~0.2.7"},"devDependencies":{"jade":"*","jshint":"*"},"scripts":{"test":"jshint --config jshint.cfg $(find . -name *.js | grep -v './node_modules')"},"keywords":["swagger","swagger-ui","express","api","jsdoc","yml","yaml","restful"],"repository":{"type":"git","url":"git://github.com/fliptoo/swagger-express"},"bugs":{"url":"https://github.com/fliptoo/swagger-express/issues"},"_id":"swagger-express@1.0.4","dist":{"shasum":"9f80e5bbc1b7c1373d5eeb5584d11f0fca776b70","tarball":"https://registry.npmjs.org/swagger-express/-/swagger-express-1.0.4.tgz","integrity":"sha512-sp01DrjsXCxlMs1d2f0OGXDdkDMy4aV3BjEOOte2Ucpye+z+9eqnpcNPYlAf7stuYuJE/Q6NuVfRodLL93obdA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICBpyIJIkT3jxkTb9i1T/RIeTqEb3QOVspcoV71rjHSuAiBE3O0F0pbeJHf3UCtzusjhQ/7X3juhviueep0XqrbyNw=="}]},"_from":".","_npmVersion":"1.3.11","_npmUser":{"name":"fliptoo","email":"fliptoo.studio@gmail.com"},"maintainers":[{"name":"fliptoo","email":"fliptoo.studio@gmail.com"}]},"1.0.5":{"name":"swagger-express","description":"Document your express rest api by jsDoc or yaml.","version":"1.0.5","author":{"name":"fliptoo","email":"fliptoo.studio@gmail.com"},"main":"./index","dependencies":{"express":"3.5.1","underscore":"*","doctrine":"*","js-yaml":"~2.1.0","coffee-script":"*","async":"~0.2.7"},"devDependencies":{"jade":"*","jshint":"*"},"scripts":{"test":"jshint --config jshint.cfg $(find . -name *.js | grep -v './node_modules')"},"keywords":["swagger","swagger-ui","express","api","jsdoc","yml","yaml","coffee-script","restful"],"repository":{"type":"git","url":"git://github.com/fliptoo/swagger-express"},"bugs":{"url":"https://github.com/fliptoo/swagger-express/issues"},"_id":"swagger-express@1.0.5","dist":{"shasum":"c73000ed846d1b334d734b47c8a34f208678b067","tarball":"https://registry.npmjs.org/swagger-express/-/swagger-express-1.0.5.tgz","integrity":"sha512-CR1rHb9aHSXPOOY74GzuB0GfvmKzYMNAuW79+GqTGjU6IZYmxo/DNs2acn9gIyXYDRrOrZbeo5oK+ClllxXajQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCYH9axJqzvtdhZ3cBjU4b7qqzVuln0I5dA2Qvgy4U0IAIhANlLI+IDNeO5f7V/TwO2kAF2C+0909mwHw6ptKCmEocP"}]},"_from":".","_npmVersion":"1.3.11","_npmUser":{"name":"fliptoo","email":"fliptoo.studio@gmail.com"},"maintainers":[{"name":"fliptoo","email":"fliptoo.studio@gmail.com"}]}},"readme":"{swagger-express}\n=========\n\n[Swagger](https://developers.helloreverb.com/swagger/) is a specification and complete framework \nimplementation for describing, producing, consuming, and visualizing RESTful web services.\nView [demo](http://petstore.swagger.wordnik.com/).\n\n__{swagger-express}__ is a simple and clean solution to integrate swagger with express.\n\n## Installation\n\n    $ npm install -g swagger-express\n\n## Quick Start\n\nConfigure {swagger-express} as express middleware.\n\n\n`apiVersion`      -> Your api version.\n\n`swaggerVersion`  -> Swagger version.\n\n`swaggerUI`       -> Where is your swagger-ui?\n\n`swaggerURL`      -> Path to use for swagger ui web interface.\n\n`swaggerJSON`     -> Path to use for swagger ui JSON.\n\n`basePath`        -> The basePath for swagger.js\n\n`apis`            -> Define your api array.\n\n`middleware`      -> Function before response.\n\n```\nvar swagger = require('swagger-express');\n\napp.configure(function(){\n  ...\n  app.use(swagger.init(app, {\n    apiVersion: '1.0',\n    swaggerVersion: '1.0',\n    swaggerURL: '/swagger',\n    swaggerJSON: '/api-docs.json',\n    swaggerUI: './public/swagger/',\n    basePath: 'http://localhost:3000',\n    apis: ['./api.js', './api.yml'],\n    middleware: function(req, res){}\n  }));\n  app.use(app.router);\n  ...\n});\n``` \n## Read from jsdoc\n\nExample 'api.js'\n\n```js\n\n/**\n * @swagger\n * resourcePath: /api\n * description: All about API\n */\n\n/**\n * @swagger\n * path: /login\n * operations:\n *   -  httpMethod: POST\n *      summary: Login with username and password\n *      notes: Returns a user based on username\n *      responseClass: User\n *      nickname: login\n *      consumes: \n *        - text/html\n *      parameters:\n *        - name: username\n *          description: Your username\n *          paramType: query\n *          required: true\n *          dataType: string\n *        - name: password\n *          description: Your password\n *          paramType: query\n *          required: true\n *          dataType: string\n */\nexports.login = function (req, res) {\n  var user = {};\n  user.username = req.param('username');\n  user.password = req.param('password');\n  res.json(user);\n}\n\n/**\n * @swagger\n * models:\n *   User:\n *     id: User\n *     properties:\n *       username:\n *         type: String\n *       password:\n *         type: String    \n */\n```\n\n## Read from yaml file\n\nExample 'api.yml'\n\n```yml\nresourcePath: /api\ndescription: All about API\napis: \n\n- path: /login\n  operations:\n\n  - httpMethod: POST\n    summary: Login with username and password\n    notes: Returns a user based on username\n    responseClass: User\n    nickname: login\n    consumes: \n      - text/html\n    parameters:\n\n    - name: username\n      dataType: string\n      paramType: query\n      required: true\n      description: Your username\n\n    - name: password\n      dataType: string\n      paramType: query\n      required: true\n      description: Your password\n\nmodels:\n    User:\n      id: User\n      properties:\n        username:\n          type: String\n        password:\n          type: String    \n```\n\n## Read from jsdoc\n\nExample 'api.coffee'\n\n```coffee\n\n###\n * @swagger\n * resourcePath: /api\n * description: All about API\n###\n\n###\n * @swagger\n * path: /login\n * operations:\n *   -  httpMethod: POST\n *      summary: Login with username and password\n *      notes: Returns a user based on username\n *      responseClass: User\n *      nickname: login\n *      consumes:\n *        - text/html\n *      parameters:\n *        - name: username\n *          description: Your username\n *          paramType: query\n *          required: true\n *          dataType: string\n *        - name: password\n *          description: Your password\n *          paramType: query\n *          required: true\n *          dataType: string\n###\n\n###\n * @swagger\n * models:\n *   User:\n *     id: User\n *     properties:\n *       username:\n *         type: String\n *       password:\n *         type: String\n###\n```\n\n\n## Examples\n\nClone the {swagger-express} repo, then install the dev dependencies:\n\n    $ git clone git://github.com/fliptoo/swagger-express.git --depth 1\n    $ cd swagger-express\n    $ npm install\n\nand run the example:\n\n    $ cd example\n    $ node app.js\n    \n# Credits\n\n- [Express](https://github.com/visionmedia/express)\n- [swagger-jack](https://github.com/feugy/swagger-jack)\n\n## License\n\n(The MIT License)\n\nCopyright (c) 2013 Fliptoo <fliptoo.studio@gmail.com>\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n'Software'), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","maintainers":[{"name":"fliptoo","email":"fliptoo.studio@gmail.com"}],"time":{"modified":"2022-06-27T02:44:41.404Z","created":"2013-03-19T08:45:44.564Z","1.0.0":"2013-03-19T08:45:50.106Z","1.0.1":"2013-04-24T02:57:47.549Z","1.0.2":"2014-02-10T14:49:09.286Z","1.0.3":"2014-02-10T15:59:52.847Z","1.0.4":"2014-02-10T16:06:56.990Z","1.0.5":"2014-04-21T03:11:18.954Z"},"author":{"name":"fliptoo","email":"fliptoo.studio@gmail.com"},"repository":{"type":"git","url":"git://github.com/fliptoo/swagger-express"},"readmeFilename":"README.md","keywords":["swagger","swagger-ui","express","api","jsdoc","yml","yaml","coffee-script","restful"],"bugs":{"url":"https://github.com/fliptoo/swagger-express/issues"},"users":{"hal9zillion":true,"yash3492":true,"natarajanmca11":true,"pagoru":true,"fredcorn":true,"hpieroni":true,"ronin161":true}}