\n\n> :star: Thanks to everyone who has starred the project, it means a lot!\n\nPlugin to handle routes in fastify automatically based on directory structure.\n\n## :newspaper: **[Full Documentation](https://giovannicardamone.github.io/fastify-autoroutes/)**\n\n[fastify-autoroutes](https://giovannicardamone.github.io/fastify-autoroutes/)\n\n## :rocket: Install\n\n```sh\nnpm install --save fastify-autoroutes\n```\n\n## :blue_book: Usage\n\n### Register plugin\n\n```js\nconst fastify = require('fastify')\nconst server = fastify()\n\nserver.register(require('fastify-autoroutes'), {\n dir: './', // relative to your cwd\n})\n```\n\n### Create file in autoroutes directory\n\n```js\n//file: `/some/route.js`\n//url: `http://your-host/some/route`\n\nexport default (fastifyInstance) => ({\n get: {\n handler: async (request, reply) => 'Hello, Route'\n },\n})\n```\n\n### Using typescript support for module\n\n```typescript\n//file: `/some/route.ts`\n//url: `http://your-host/some/route`\n\nimport { FastifyInstance } from 'fastify'\nimport { Resource } from 'fastify-autoroutes'\n\nexport default (fastify: FastifyInstance) => {\n get: {\n handler: async (request: FastifyRequest, reply: FastifyReply) => 'Hello, Route!'\n }\n}\n```\n\n### Accepts params in autoroutes\n\n> :information_source: file/directory name must follow syntax `:paramName` or `{paramName}`\n\n```js\n//file: `/users/{userId}/photos.js`\n//mapped to: `/users/:userId/photos`\n\nexport default (fastifyInstance) => ({\n get: {\n handler: (request, reply) => {\n reply.send(`photos of user ${request.params.userId}`)\n }\n },\n})\n```\n\n## :arrow_forward: Route module definition\n\nMethod specification for attributes is available here: [Method specification](https://www.fastify.io/docs/latest/Routes/#full-declaration)\n\n> :information_source: attributes `url` and `method` are dynamically provided\n\nAllowed attributes mapped to Http methods in module:\n\n- delete\n- get\n- head\n- patch\n- post\n- put\n- options\n\n## :arrow_forward: Skipping files\n\nto skip file in routes directory, prepend the `.` or `_` character to filename\n\nexamples:\n\n```text\nroutes\n├── .ignored-directory\n├── _ignored-directory\n├── .ignored-js-file.js\n├── _ignored-js-file.js\n├── .ignored-ts-file.ts\n├── _ignored-ts-file.ts\n├── ignored-js-test.test.js\n└── ignored-ts-test.test.ts\n```\n\n> :warning: also any `*.test.js` and `*.test.ts` are skipped!\n\nthis is useful if you want to have a lib file which contains functions that don't have to be a route, so just create the file with `_` prepending character\n\n## :page_facing_up: License\n\nLicensed under [MIT](./LICENSE)\n\n## :sparkles: Contributors\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\n\n\n
\n\n\n\n\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.\n\nContributions of any kind welcome!\n","readmeFilename":"README.md","contributors":[{"name":"Giovanni Cardamone","email":"g.cardamone2@gmail.com","url":"https://giovannicardamone.github.io"},{"name":"Gennaro Bosone","email":"gennaro.bs@gmail.com","url":"https://www.desidus.it"}]}
![\"\"/](\"https://avatars0.githubusercontent.com/u/5117748?v=4\")
![\"\"/](\"https://avatars0.githubusercontent.com/u/6159598?v=4\")