{"id":18905061,"url":"https://github.com/kenberkeley/express-auto-routes","last_synced_at":"2025-04-15T04:13:03.175Z","repository":{"id":143878722,"uuid":"59455912","full_name":"kenberkeley/express-auto-routes","owner":"kenberkeley","description":"Mount express controllers to routes automatically / Express 自动路由（DEPRECATED）","archived":false,"fork":false,"pushed_at":"2019-01-09T03:25:06.000Z","size":60,"stargazers_count":13,"open_issues_count":0,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-10T02:05:57.916Z","etag":null,"topics":["express","routes"],"latest_commit_sha":null,"homepage":"","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/kenberkeley.png","metadata":{"files":{"readme":"README-CN.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-05-23T06:00:50.000Z","updated_at":"2022-04-22T03:38:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"622df650-fa02-424b-8113-4a010935ce7f","html_url":"https://github.com/kenberkeley/express-auto-routes","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/kenberkeley%2Fexpress-auto-routes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kenberkeley%2Fexpress-auto-routes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kenberkeley%2Fexpress-auto-routes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kenberkeley%2Fexpress-auto-routes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kenberkeley","download_url":"https://codeload.github.com/kenberkeley/express-auto-routes/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248923724,"owners_count":21183953,"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":["express","routes"],"created_at":"2024-11-08T09:10:30.435Z","updated_at":"2025-04-15T04:13:03.152Z","avatar_url":"https://github.com/kenberkeley.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Express 自动(挂载)路由\r\n[![NPM version][npm-image]][npm-url]\r\n[![Downloads][downloads-image]][npm-url]\r\n[![build status][travis-image]][travis-url]\r\n[![Dependency Status][dep-image]][dep-url]\r\n[![Coverage Status][cov-img]][cov-url]\r\n\r\n大多数情况下，我们都需要手动将控制器挂载到挂载路由上。\r\n\r\n***例子***\r\n\r\n```javascript\r\n/** 当前位置 routes/index.js **/\r\nvar homeRouter = require('./home/'),\r\n  userCtrl = require('../controllers/user');\r\n\r\n// 方式 1: 把子路由挂载到路径。有点代码分离的感觉但还是很复杂\r\napp.use('/', homeRouter);\r\n\r\n// 方式 2: 直接一个一个地挂载控制器，坑爹\r\napp.get('/user', userCtrl.index);\r\napp.post('/user/login', userCtrl.login);\r\napp.get('/user/logout', userCtrl.logout);\r\n...\r\n```\r\n\r\n****\r\n\r\n这真的很难称得上是优雅。因此我们的  **express-auto-routes** 应运而生。  \r\n首先，需要安装一下 **```npm install express-auto-routes --save```**  \r\n\r\n***例子***\r\n\r\n```javascript\r\n/** 当前位置 app.js **/\r\nvar path = require('path'),\r\n  express = require('express'),\r\n  app = express();\r\n\r\nvar autoRoutes = require('express-auto-routes')(app); // 你再也不需要 `routes` 目录\r\nautoRoutes(path.join(__dirname, './controllers')); // 自动路由中...搞定！\r\n\r\n// ...其他配置\r\n\r\napp.listen(8080);\r\n```\r\n\r\n```javascript\r\n/** 当前位置 controllers/hello/world.js **/\r\nexports.get = function (req, res, next) {\r\n  res.send('hello world');\r\n};\r\n```\r\n\r\n随后访问 `localhost:8080/hello/world`, 你会看到 `hello world`\r\n\r\n****\r\n\r\n这实际上就是遍历文件夹，基于相对路径提取、解析**有效的**控制器文件。  \r\n既然是递归遍历文件夹，因此毫无疑问是支持无限子目录。\r\n\r\n***例子***\r\n\r\n```javascript\r\ncontrollers/a/b/c/d/e/f/g.js =\u003e localhost:8080/a/b/c/d/e/f/g\r\n```\r\n\r\n****\r\n\r\n在这里我推荐您浏览 `example/` 目录了解使用方法。\r\n\r\n```\r\n\u003e npm install\r\n\u003e npm run example\r\n\r\n[AutoMount] use /home/\r\n[AutoMount] use /user/\r\n[AutoMount] use /user/logout/\r\n[AutoMount] all /user/setting/\r\n[AutoMount] get /home/foo/bar/world/\r\n[AutoMount] get /user/setting/:uid\r\n[AutoMount] delete /user/logout/:uid\r\n[AutoMount] get /home/foo/hello/\r\n[AutoMount] get /home/foo/bar/\r\n[AutoMount] get /user/logout/\r\n[AutoMount] get /user/:uid?\r\n[AutoMount] get /home/foo/\r\n[AutoMount] get /home/xyz/\r\n[AutoMount] post /setting\r\n[AutoMount] get /login\r\n[AutoMount] get /home/\r\n[AutoMount] post /login\r\n[AutoMount] put /user/\r\n[AutoMount] post /log\r\n[AutoMount] get /\r\n```\r\n\r\n运行后，可使用 [Postman](https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop) 访问 `localhost:8080` 测试上面的接口。\r\n\r\n****\r\n\r\n\u003e [ 一个更实际的例子 ] 请点击 [简易留言板 RESTful API](https://github.com/kenberkeley/msg-board-api)\r\n\r\n\r\n[npm-url]: https://npmjs.org/package/express-auto-routes\r\n[downloads-image]: http://img.shields.io/npm/dm/express-auto-routes.svg\r\n[npm-image]: http://img.shields.io/npm/v/express-auto-routes.svg\r\n[travis-image]: https://secure.travis-ci.org/kenberkeley/express-auto-routes.svg?branch=master\r\n[travis-url]: https://travis-ci.org/kenberkeley/express-auto-routes\r\n[dep-image]: http://david-dm.org/kenberkeley/express-auto-routes.svg?style=flat-square\r\n[dep-url]: http://david-dm.org/kenberkeley/express-auto-routes\r\n[cov-img]: https://coveralls.io/repos/github/kenberkeley/express-auto-routes/badge.svg?branch=master\r\n[cov-url]: https://coveralls.io/github/kenberkeley/express-auto-routes?branch=master\r\n\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkenberkeley%2Fexpress-auto-routes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkenberkeley%2Fexpress-auto-routes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkenberkeley%2Fexpress-auto-routes/lists"}