{"id":20942092,"url":"https://github.com/salakjs/salak-swagger","last_synced_at":"2026-04-16T09:03:27.791Z","repository":{"id":57356066,"uuid":"114767691","full_name":"SalakJS/salak-swagger","owner":"SalakJS","description":"Swagger for salak base on koa \u0026 joi.","archived":false,"fork":false,"pushed_at":"2019-03-20T12:28:47.000Z","size":14,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-23T02:37:38.758Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SalakJS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-12-19T13:21:57.000Z","updated_at":"2019-03-20T12:27:06.000Z","dependencies_parsed_at":"2022-09-26T16:32:05.406Z","dependency_job_id":null,"html_url":"https://github.com/SalakJS/salak-swagger","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SalakJS%2Fsalak-swagger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SalakJS%2Fsalak-swagger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SalakJS%2Fsalak-swagger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SalakJS%2Fsalak-swagger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SalakJS","download_url":"https://codeload.github.com/SalakJS/salak-swagger/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243335382,"owners_count":20274898,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-18T23:22:38.488Z","updated_at":"2025-12-26T09:20:08.206Z","avatar_url":"https://github.com/SalakJS.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# salak-swagger\n\n[![NPM version][npm-image]][npm-url]\n[![build status][travis-image]][travis-url]\n[![David deps][david-image]][david-url]\n[![NPM download][download-image]][download-url]\n\n[npm-image]: https://img.shields.io/npm/v/salak-swagger.svg?style=flat-square\n[npm-url]: https://npmjs.org/package/salak-swagger\n[travis-image]: https://img.shields.io/travis/SalakJS/salak-swagger.svg?style=flat-square\n[travis-url]: https://travis-ci.org/SalakJS/salak-swagger\n[david-image]: https://img.shields.io/david/SalakJS/salak-swagger.svg?style=flat-square\n[david-url]: https://david-dm.org/SalakJS/salak-swagger\n[download-image]: https://img.shields.io/npm/dm/salak-swagger.svg?style=flat-square\n[download-url]: https://npmjs.org/package/salak-swagger\n\nFor generating Swagger 2.0 JSON from router\n\n## API\n\n### generateSwaggerSpec (router, baseSpec, options)\n\nrouter config:  \n- prefix: the api path  \n- modules\n\nbaseSpec: Swagger base info  \n- info: like title, version, description, contact...  \n- tags: array\n\noptions:  \n- defaultResponses\n\n## Install\n\n```bash\nnpm install --save salak-swagger\n```\n\n## Usage\n\n```javascript\nconst { generateSwaggerSpec } = require('salak-swagger')\nconst Joi = require('joi')\n\nconst swagger = generateSwaggerSpec({\n  prefix: '/api',\n  modules: [\n    {\n      name: 'blog',\n      routes: [\n        {\n          path: '/:id',\n          method: ['GET'],\n          meta: {\n            summary: '',\n            description: '',\n            tags: ['文章']\n          },\n          validate: {\n            header: Joi.object().keys({\n              Authorization: Joi.string().required()\n            }),\n            params: {\n              id: Joi.string().required().description('Article id')\n            },\n            query: {\n              id: Joi.string().required()\n            },\n            responses: {\n              200: {\n                body: Joi.object().keys({\n                  code: Joi.number(),\n                  msg: Joi.string()\n                }),\n                headers: Joi.object().keys({\n                  authorization: Joi.string().required()\n                }).options({\n                  allowUnknown: true\n                })\n              }\n            }\n          }\n        }\n      ]\n    }\n  ]\n}, {\n  info: {\n    description: 'Blog api',\n    version: '1.0.0',\n    title: 'Blog Swagger',\n    contact: {\n      name: 'wengeek',\n      email: 'xxx.xxx@xxx.com'\n    }\n  }\n})\n\nconsole.log(swagger)\n```\n\n## LICENSE\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsalakjs%2Fsalak-swagger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsalakjs%2Fsalak-swagger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsalakjs%2Fsalak-swagger/lists"}