{"id":22502353,"url":"https://github.com/rickyli79/egg-openapi-router","last_synced_at":"2026-05-05T05:39:09.079Z","repository":{"id":57220639,"uuid":"340659239","full_name":"RickyLi79/egg-openapi-router","owner":"RickyLi79","description":"init `router` and connect `controller` by Openapi-doc. validate the request and response by Openapi-doc","archived":false,"fork":false,"pushed_at":"2021-02-26T17:32:37.000Z","size":665,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-02T23:05:15.372Z","etag":null,"topics":["egg","egg-plugin","eggplugin","openapi","route","schema","valid"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/RickyLi79.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":"2021-02-20T13:19:06.000Z","updated_at":"2021-02-26T17:32:39.000Z","dependencies_parsed_at":"2022-08-28T23:23:53.424Z","dependency_job_id":null,"html_url":"https://github.com/RickyLi79/egg-openapi-router","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RickyLi79%2Fegg-openapi-router","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RickyLi79%2Fegg-openapi-router/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RickyLi79%2Fegg-openapi-router/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RickyLi79%2Fegg-openapi-router/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RickyLi79","download_url":"https://codeload.github.com/RickyLi79/egg-openapi-router/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245937930,"owners_count":20696988,"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":["egg","egg-plugin","eggplugin","openapi","route","schema","valid"],"created_at":"2024-12-06T23:17:26.685Z","updated_at":"2026-05-05T05:39:09.045Z","avatar_url":"https://github.com/RickyLi79.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# egg-openapi-router\n[![NPM version][npm-image]][npm-url]\n[![npm download][download-image]][download-url]\n![NPM](https://img.shields.io/npm/l/egg-openapi-router?style=flat-square)\n\n[npm-image]: https://img.shields.io/npm/v/egg-openapi-router.svg?style=flat-square\n[npm-url]: https://npmjs.org/package/egg-openapi-router\n[download-image]: https://img.shields.io/npm/dm/egg-openapi-router.svg?style=flat-square\n[download-url]: https://npmjs.org/package/egg-openapi-router\n\n[@rickyli79/koa-openapi-router](https://github.com/RickyLi79/koa-openapi-router) plugin for Egg.js.\n\n\u003e NOTE: This plugin just for Egg.js, more documentation please visit https://github.com/RickyLi79/koa-openapi-router.\n\n## Install\n\n```bash\n$ npm i --save egg-openapi-router\n```\n\n## Usage \u0026 configuration\n\n#### Enable plugin in `config/plugin.js`\n\n``` js\nexports.openapiRouter = {\n  enable: true,\n  package: 'egg-openapi-router'\n}\n```\n\n#### Edit your own configurations in `config/config.{env}.js`\n\n- Single config\n  ```js\n  // config/config.{env}.js\n  exports.openapiRouter = {\n    config: {\n      controllerDir: 'my/api/dir', // default: ''\n      docsDir: path.join(appInfo.baseDir, 'my-openapi-doc'), // default: path.join(appInfo.baseDir, 'openapi-doc')\n      routerPrefix: '/myApi', // default : ''\n    },\n  };\n  ```\n- Muti Configs\n  ```js\n  // config/config.{env}.js\n  exports.openapiRouter = {\n    configs: {\n      'my/api/module/1': {\n        controllerDir: 'module-1',\n        docsDir: path.join(appInfo.baseDir, 'openapi-doc-module-1'),\n      },\n      'my/api/module/2': {\n        controllerDir: 'module-2',\n        docsDir: path.join(appInfo.baseDir, 'openapi-doc-module-2'),\n      },\n    },\n  };\n  ```\n\n## Examples\n\n#### openapi-docs:\n```yaml\n# openapi-doc/my.oas3.json\nopenapi: \"3.0.0\"\npaths:\n  /hello:\n    get:\n      responses:\n        200:\n          description: ok\n```\n\n#### edit `config/config.{env}.js`:\n```js\n// config/config.{env}.js\nexports.openapiRouter = {\n  config: {\n    controllerDir: '', \n    docsDir: path.join(appInfo.baseDir, 'openapi-doc'),\n    routerPrefix: '',\n  },\n};\n```\n\n#### controller:\n```js\n// app/controller/default.js\nconst Controller = require('egg').Controller;\nclass DefaultController extends Controller {\n  async 'GET /hello'() {\n    const { ctx } = this;\n    ctx.status = 200;\n    ctx.body = 'nihao';\n  }\n}\nmodule.exports = DefaultController;\n```\n\n\u003e More documentation please visit https://github.com/RickyLi79/koa-openapi-router.\n\n#### Example\n[Here](https://github.com/RickyLi79/openapi-mock-server) is an example for [@rickyli79/json-schema-mock](https://npmjs.org/package/@rickyli79/json-schema-mock) and [egg-openapi-router](https://npmjs.org/package/egg-openapi-router)\n\n\n#### Test Report\n[Allure Report](https://rickyli79.github.io/testing-reports/egg-openapi-router/allure-report/)\n\n## License\n\n[MIT](LICENSE)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frickyli79%2Fegg-openapi-router","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frickyli79%2Fegg-openapi-router","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frickyli79%2Fegg-openapi-router/lists"}