{"_id":"@8select/serverless-plugin-api-docs","_rev":"31-28a5fb09697be0e21ef9ddf9070ba6d7","name":"@8select/serverless-plugin-api-docs","description":"serverless plugin that generates docs function to return swagger ui","dist-tags":{"latest":"2.0.0"},"versions":{"1.0.0":{"name":"@8select/serverless-plugin-api-docs","version":"1.0.0","description":"serverless plugin that generates docs function to return swagger ui","main":"index.js","files":["index.js","docs.js","LICENSE","README.md"],"keywords":["8select","javascript","serverless","docs"],"scripts":{"precommit":"lint-staged","changelog":"github-changes -o 8select -r serverless-plugin-api-docs -a --only-pulls --use-commit-body","test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/8select/serverless-plugin-api-docs.git"},"author":{"name":"8select Software GmbH"},"license":"MIT","bugs":{"url":"https://github.com/8select/serverless-plugin-api-docs/issues"},"homepage":"https://github.com/8select/serverless-plugin-api-docs#readme","devDependencies":{"eslint":"^4.5.0","eslint-config-8select-node":"github:8select/eslint-config-8select-node","github-changes":"^1.1.0","husky":"^0.14.3","lint-staged":"^4.0.4","prettier":"^1.6.0"},"lint-staged":{"*.js":["prettier --print-width 120 --no-semi --single-quote --write","eslint --fix","git add"]},"gitHead":"18e582ab883a481534156c276cf45690d3e384b1","_id":"@8select/serverless-plugin-api-docs@1.0.0","_npmVersion":"5.3.0","_nodeVersion":"8.1.4","_npmUser":{"name":"swirth","email":"stephan.wirth@mail.de"},"dist":{"integrity":"sha512-+1kBJrcgPagUN2STSNczgWebQGDZM9AesVS7O5pKtZd4RKcoERVnKlRfwG7WO9Te5MKWjAL7Rb/LTi5p+OMn3w==","shasum":"2e9c5c9c237cdad8fcca380909723dd0ce7b57c3","tarball":"https://registry.npmjs.org/@8select/serverless-plugin-api-docs/-/serverless-plugin-api-docs-1.0.0.tgz","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDoekJsomIjKebFoRa6+GLWsBj7pk+kVwXMhmei3pAFbgIgPXaOFKKT29Fu8u0svXnx1J2qr1R+vvHSn1TqMMWg79k="}]},"maintainers":[{"name":"swirth","email":"stephan.wirth@mail.de"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/serverless-plugin-api-docs-1.0.0.tgz_1504009643120_0.5413222010247409"},"directories":{}},"1.0.1":{"name":"@8select/serverless-plugin-api-docs","version":"1.0.1","description":"serverless plugin that generates docs function to return swagger ui","main":"index.js","files":["index.js","docs.js","LICENSE","README.md"],"keywords":["8select","javascript","serverless","docs"],"scripts":{"precommit":"lint-staged","changelog":"github-changes -o 8select -r serverless-plugin-api-docs -a --only-pulls --use-commit-body","test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/8select/serverless-plugin-api-docs.git"},"author":{"name":"8select Software GmbH"},"license":"MIT","bugs":{"url":"https://github.com/8select/serverless-plugin-api-docs/issues"},"homepage":"https://github.com/8select/serverless-plugin-api-docs#readme","devDependencies":{"eslint":"^4.5.0","eslint-config-8select-node":"github:8select/eslint-config-8select-node","github-changes":"^1.1.0","husky":"^0.14.3","lint-staged":"^4.0.4","prettier":"^1.6.0"},"lint-staged":{"*.js":["prettier --print-width 120 --no-semi --single-quote --write","eslint --fix","git add"]},"gitHead":"6f9175f2478da1a94c09777233da90e3af1516b9","_id":"@8select/serverless-plugin-api-docs@1.0.1","_npmVersion":"5.3.0","_nodeVersion":"8.1.4","_npmUser":{"name":"swirth","email":"stephan.wirth@mail.de"},"dist":{"integrity":"sha512-WjvMrokQXGebvJ81Rh+KjdsYz9E/Y/xgsukSJtYuppyWQgLb1vxcyuFAZDgtrn8xpzEPSjJmp8t6f7+LViAvlQ==","shasum":"23c5d19ff01bf4d1b2361ffd87e571d43ffc7316","tarball":"https://registry.npmjs.org/@8select/serverless-plugin-api-docs/-/serverless-plugin-api-docs-1.0.1.tgz","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC8GPWje2hlVNUPflAzxpMJyWkhtPgAg3RqvIMgySbXSgIge8dO1lz/noKf80vW2SJtjHjQPADaBtqndxeeErjnoSE="}]},"maintainers":[{"email":"stephan.wirth@mail.de","name":"swirth"},{"email":"dominik.stoetter@8select.de","name":"domis4"},{"email":"mail@robertschweizer.me","name":"rschweizer"},{"email":"andreas.kleiber@8select.de","name":"akleiber"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/serverless-plugin-api-docs-1.0.1.tgz_1504114951589_0.7646304653026164"},"directories":{}},"1.0.2":{"name":"@8select/serverless-plugin-api-docs","version":"1.0.2","description":"serverless plugin that generates docs function to return swagger ui","main":"index.js","files":["index.js","docs.js","LICENSE","README.md"],"keywords":["8select","javascript","serverless","docs"],"scripts":{"precommit":"lint-staged","changelog":"github-changes -o 8select -r serverless-plugin-api-docs -a --only-pulls --use-commit-body","test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/8select/serverless-plugin-api-docs.git"},"author":{"name":"8select Software GmbH"},"license":"MIT","bugs":{"url":"https://github.com/8select/serverless-plugin-api-docs/issues"},"homepage":"https://github.com/8select/serverless-plugin-api-docs#readme","devDependencies":{"eslint":"^4.5.0","eslint-config-8select-node":"github:8select/eslint-config-8select-node","github-changes":"^1.1.0","husky":"^0.14.3","lint-staged":"^4.0.4","prettier":"^1.6.0"},"lint-staged":{"*.js":["prettier --print-width 120 --no-semi --single-quote --write","eslint --fix","git add"]},"gitHead":"899d8cae578451fbd9aef431eea4801928e36407","_id":"@8select/serverless-plugin-api-docs@1.0.2","_npmVersion":"5.3.0","_nodeVersion":"8.1.4","_npmUser":{"name":"swirth","email":"stephan.wirth@mail.de"},"dist":{"integrity":"sha512-Y5HvAQC/6vHbulY6p7W11oGG1vk1H/SRToiEGH8ggkLH3Eug5aQEbU+zBCKdS/ypZBDoF0YRLeRTC+PwF68ZVg==","shasum":"139d40a1542bc9bbdb8fd560943533518e721d8b","tarball":"https://registry.npmjs.org/@8select/serverless-plugin-api-docs/-/serverless-plugin-api-docs-1.0.2.tgz","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDK+MDxoJ1haNfkpTRJCpYKJbkfeww8oEZY/SL8shqLDQIhAOnplJ+7I2y65ZoOcD8kvOLL4GqsPB2nbAQs3/kiTl5q"}]},"maintainers":[{"email":"stephan.wirth@mail.de","name":"swirth"},{"email":"dominik.stoetter@8select.de","name":"domis4"},{"email":"mail@robertschweizer.me","name":"rschweizer"},{"email":"andreas.kleiber@8select.de","name":"akleiber"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/serverless-plugin-api-docs-1.0.2.tgz_1504116856796_0.24932631407864392"},"directories":{}},"2.0.0":{"name":"@8select/serverless-plugin-api-docs","version":"2.0.0","description":"serverless plugin that generates docs function to return swagger ui","main":"index.js","files":["index.js","docs.js","LICENSE","README.md"],"keywords":["8select","javascript","serverless","docs"],"scripts":{"precommit":"lint-staged","changelog":"github-changes -o 8select -r serverless-plugin-api-docs -a --only-pulls --use-commit-body","test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/8select/serverless-plugin-api-docs.git"},"author":{"name":"8select Software GmbH"},"license":"MIT","bugs":{"url":"https://github.com/8select/serverless-plugin-api-docs/issues"},"homepage":"https://github.com/8select/serverless-plugin-api-docs#readme","devDependencies":{"eslint":"^4.5.0","eslint-config-8select":"^1.0.0","github-changes":"^1.1.0","husky":"^0.14.3","lint-staged":"^4.0.4","prettier":"^1.6.0"},"gitHead":"7e286bc0b2614ca7725d2753b59a85da09d363b9","_id":"@8select/serverless-plugin-api-docs@2.0.0","_npmVersion":"5.5.1","_nodeVersion":"8.9.1","_npmUser":{"name":"jbreckel","email":"julius.breckel@gmail.com"},"dist":{"integrity":"sha512-GRty9r/u/lXuzMqJa7dl/TIrmFInz87sAN0LHolm+ciuc1Pm8Y70wkr9hjDGRc7IvcjuxwcY6ljFqBM3WnfyOg==","shasum":"52c713ca8e3fbc7da6e55a2c1d5b55f5a6b1a895","tarball":"https://registry.npmjs.org/@8select/serverless-plugin-api-docs/-/serverless-plugin-api-docs-2.0.0.tgz","npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhuwgSCRA9TVsSAnZWagAAA2wP/33Xv965MBNjyRAOM1Zw\n7/OlrsGtRkITDLMOu6/7JPujqgzwEvc5MvyecpobW9mKEr4/QxQ+AUIf4S6F\n4AR9jFcrVfshjoZZoOwPEh4CQBp5DB0IedCo53g8KeiLlOcnsK10Zo1ZLLfm\nIJeON1HVJDzatj1lmywmWzXRhg2xrkMDp73hh0YtbNjeAG7BhIycJjeavHD4\nBQVju8sG6J0T8VTGP4BxZNxz60JtoVbpwFgwiDSDLfCwOdtw8X+CFjLORSD9\nFxR+/YQcwWfN/nMfk3Tc4eMmn3WUBabK+Iba6582vPQsZ5b1xS26+JckGevV\nv6jTzo1hDjPyJDsyLDIyR2xOiUfsv5kf/TTopbWiZbWSg1VtIrIfy1tfPvg2\nLceRKtxAvi74gmIbeFnKMOg95sLne209Js+nOcIY24PqHpr/BapfIiuwuuEl\numo8RRLyeRKs91wbmtq2yaxCMskquN4PBW5YW59FtHyG8cwSB9Dflrannajj\nQA+6PyTawEo/4l8vXVjC+XJ8WcpIjomYDmLxsRT+XJcW/nbdTUuLO3pv9phk\nXBctkTux5NtbD0/MoB633+//Xtktql33HCSSOc4djyAU8TTGfFeQ5q5E1uyR\nRNT/mx1F9yIMyeXO8piRtlXngp8JwGRO42kd0YLL8PBPhBE1ZBDclz13sSTf\nN8lI\r\n=5+Un\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDEkM90nxw2+FlxU7Xovq6Dks5jsm+xxNpGnmgbyMqtJgIgMLKaXf7oMfbGNKlDmT6CJabzJSv4XVGZAFlz2lhDDf8="}]},"maintainers":[{"email":"julius.breckel@gmail.com","name":"jbreckel"},{"email":"andreas.kleiber@8select.de","name":"akleiber"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/serverless-plugin-api-docs-2.0.0.tgz_1512744825393_0.2140808179974556"},"directories":{}}},"readme":"# serverless-plugin-api-docs\n\n[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)\n\nWork with [SWAGGER](https://swagger.io/docs/specification) documentation for [Serverless v1.0](https://serverless.com/)\nprojects.\n\nA [serverless](http://www.serverless.com) plugin to **automatically** create a lambda function which returns the\nswagger-ui HTML based on the given swagger spec JSON file `GET /docs` => swagger-ui\n\n## Install\n\nusing `npm`:\n\n```\nnpm install --save-dev @8select/serverless-plugin-api-docs\n```\n\nor `yarn`:\n\n```\nyarn add -D @8select/serverless-plugin-api-docs\n```\n\nAdd the plugin to your `serverless.yml` file:\n\n```yaml\nplugins:\n - serverless-plugin-api-docs\n```\n\n## Prerequisites\n\n[Download](https://swagger.io/swagger-ui/) and host swagger-ui library files e.g. with S3\n\n* swagger-ui.css\n* swagger-ui-bundle.js\n* swagger-ui-standalone-preset.js\n\n## Configuration\n\n```yaml\ncustom:\n documentation:\n contentUrl: '' # REQUIRED\n name: '' # OPTIONAL - default = 'docs'\n```\n\nTo load your `swagger.json` you need to add a `resolve.alias`. \nE.g. for `webpack`: \n_Assupmtion_:\n\n```\n\n |\n |-docs - REST API swagger spec & definitions\n | swagger.json\n | webpack.config.json\n```\n\n```js\nmodule.exports = {\n // [...],\n resolve: {\n alias: {\n PATH_TO_SWAGGER_SPEC: path.resolve(__dirname, 'docs/swagger.json'),\n },\n },\n // [...],\n}\n```\n","maintainers":[{"email":"mail@robdasilva.com","name":"robdasilva"},{"email":"andreas.kleiber@8select.de","name":"akleiber"}],"time":{"modified":"2023-07-10T07:13:28.608Z","created":"2017-08-29T12:27:24.113Z","1.0.0":"2017-08-29T12:27:24.113Z","1.0.1":"2017-08-30T17:42:32.562Z","1.0.2":"2017-08-30T18:14:17.759Z","2.0.0":"2017-12-08T14:53:45.485Z"},"homepage":"https://github.com/8select/serverless-plugin-api-docs#readme","keywords":["8select","javascript","serverless","docs"],"repository":{"type":"git","url":"git+https://github.com/8select/serverless-plugin-api-docs.git"},"author":{"name":"8select Software GmbH"},"bugs":{"url":"https://github.com/8select/serverless-plugin-api-docs/issues"},"license":"MIT","readmeFilename":"README.md"}