{"id":13798755,"url":"https://github.com/TheOne1006/egg-swagger","last_synced_at":"2025-05-13T06:31:33.388Z","repository":{"id":42098611,"uuid":"103820748","full_name":"TheOne1006/egg-swagger","owner":"TheOne1006","description":"swagger-ui plugin for egg ，Demo:","archived":false,"fork":false,"pushed_at":"2023-01-23T22:25:30.000Z","size":1826,"stargazers_count":26,"open_issues_count":18,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-02-14T23:35:13.048Z","etag":null,"topics":["egg","egg-loopback","egg-plugin","egg-remote","swagger-ui"],"latest_commit_sha":null,"homepage":"http://egg-swagger-demo.herokuapp.com/explorer","language":"HTML","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/TheOne1006.png","metadata":{"files":{"readme":"README.md","changelog":"HISTORY.md","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-09-17T10:31:32.000Z","updated_at":"2022-01-17T16:22:38.000Z","dependencies_parsed_at":"2023-01-24T02:16:40.792Z","dependency_job_id":null,"html_url":"https://github.com/TheOne1006/egg-swagger","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/TheOne1006%2Fegg-swagger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheOne1006%2Fegg-swagger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheOne1006%2Fegg-swagger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheOne1006%2Fegg-swagger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TheOne1006","download_url":"https://codeload.github.com/TheOne1006/egg-swagger/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253888858,"owners_count":21979518,"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-loopback","egg-plugin","egg-remote","swagger-ui"],"created_at":"2024-08-04T00:00:52.261Z","updated_at":"2025-05-13T06:31:33.078Z","avatar_url":"https://github.com/TheOne1006.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# egg-swagger\n\n[![NPM version][npm-image]][npm-url]\n[![build status][travis-image]][travis-url]\n[![Test coverage][codecov-image]][codecov-url]\n[![David deps][david-image]][david-url]\n[![Known Vulnerabilities][snyk-image]][snyk-url]\n[![npm download][download-image]][download-url]\n\n[npm-image]: https://img.shields.io/npm/v/egg-swagger.svg?style=flat-square\n[npm-url]: https://npmjs.org/package/egg-swagger\n[travis-image]: https://img.shields.io/travis/TheOne1006/egg-swagger.svg?style=flat-square\n[travis-url]: https://travis-ci.org/TheOne1006/egg-swagger\n[codecov-image]: https://img.shields.io/codecov/c/github/TheOne1006/egg-swagger.svg?style=flat-square\n[codecov-url]: https://codecov.io/github/TheOne1006/egg-swagger?branch=master\n[david-image]: https://img.shields.io/david/TheOne1006/egg-swagger.svg?style=flat-square\n[david-url]: https://david-dm.org/TheOne1006/egg-swagger\n[snyk-image]: https://snyk.io/test/npm/egg-swagger/badge.svg?style=flat-square\n[snyk-url]: https://snyk.io/test/npm/egg-swagger\n[download-image]: https://img.shields.io/npm/dm/egg-swagger.svg?style=flat-square\n[download-url]: https://npmjs.org/package/egg-swagger\n\negg plugin，support swagger-ui 2.0.\n\n## Install\n\n```bash\n$ npm i egg-swagger --save\n```\n\n## Usage\n\n```js\n// {app_root}/config/plugin.js\nexports.swagger = {\n  enable: true,\n  package: 'egg-swagger',\n};\n```\n\n## Configuration\n\n```js\n// {app_root}/config/config.default.js\nexports.swagger = {\n  enable: true,\n  mountPath: '/test-mount', // swagger-ui  address  \u003cdomain\u003e/test-mount\n  swaggerFilePath: '/test-swagger.json', // swagger file default path\n  enableGoogleFont: false,\n};\n```\n\nsee [config/config.default.js](config/config.default.js) for more detail.\n\n## Example\n\n- [swagger-ui](http://petstore.swagger.io/?_ga=2.67112721.1460016005.1511156320-1698683464.1510724052) 对外开放 restful api\n\u003c!-- example here --\u003e\n\n\n## Tips\n\n搭配 \u003chttps://github.com/TheOne1006/egg-connector-remote\u003e 可直接生成对应的 swagger 数据\n\n## 依赖说明\n\nswagger.json 规则来自于\n\u003chttps://editor.swagger.io/?_ga=2.41951072.471192285.1510301833-940518916.1510301833#/\u003e\n\n## Questions \u0026 Suggestions\n\nPlease open an issue [here](https://github.com/TheOne1006/egg-swagger/issues).\n\n## License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTheOne1006%2Fegg-swagger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTheOne1006%2Fegg-swagger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTheOne1006%2Fegg-swagger/lists"}