Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/giovannicardamone/fastify-autoroutes
fastest way to map directories to URLs in fastify
https://github.com/giovannicardamone/fastify-autoroutes
autoroute autoroutes autorouting fastify fastify-autoroutes fastify-plugin
Last synced: 3 days ago
JSON representation
fastest way to map directories to URLs in fastify
- Host: GitHub
- URL: https://github.com/giovannicardamone/fastify-autoroutes
- Owner: GiovanniCardamone
- License: mit
- Created: 2020-08-06T09:26:13.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-30T16:15:47.000Z (over 1 year ago)
- Last Synced: 2024-12-09T19:53:14.532Z (13 days ago)
- Topics: autoroute, autoroutes, autorouting, fastify, fastify-autoroutes, fastify-plugin
- Language: TypeScript
- Homepage: https://giovannicardamone.github.io/fastify-autoroutes/
- Size: 328 KB
- Stars: 85
- Watchers: 3
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# fastify-autoroutes
 
[](https://www.npmjs.com/package/fastify-autoroutes)
[](https://www.npmjs.com/package/fastify-autoroutes)
[](https://snyk.io/test/github/GiovanniCardamone/fastify-autoroutes)
[](https://github.com/GiovanniCardamone/fastify-autoroutes/blob/master/LICENSE)
[](https://coveralls.io/github/GiovanniCardamone/fastify-autoroutes?branch=master)
> :star: Thanks to everyone who has starred the project, it means a lot!
Plugin to handle routes in fastify automatically based on directory structure.
## :newspaper: **[Full Documentation](https://giovannicardamone.github.io/fastify-autoroutes/)**
[fastify-autoroutes](https://giovannicardamone.github.io/fastify-autoroutes/)
## :rocket: Install
```sh
npm install --save fastify-autoroutes
```
## :blue_book: Usage
### Register plugin
```js
const fastify = require('fastify')
const server = fastify()
server.register(require('fastify-autoroutes'), {
dir: './', // relative to your cwd
prefix: '/api', // optional, don't use if you do not need prefixes
})
```
### Create file in autoroutes directory
```js
//file: `/some/route.js`
//url: `http://your-host/some/route`
export default (fastifyInstance) => ({
get: {
handler: async (request, reply) => 'Hello, Route'
},
})
```
### Using typescript support for module
```typescript
//file: `/some/route.ts`
//url: `http://your-host/some/route`
import { FastifyInstance } from 'fastify'
import { Resource } from 'fastify-autoroutes'
export default (fastify: FastifyInstance) => {
get: {
handler: async (request: FastifyRequest, reply: FastifyReply) => 'Hello, Route!'
}
}
```
### Accepts params in autoroutes
> :information_source: file/directory name must follow syntax `:paramName` or `{paramName}`
```js
//file: `/users/{userId}/photos.js`
//mapped to: `/users/:userId/photos`
export default (fastifyInstance) => ({
get: {
handler: (request, reply) => {
reply.send(`photos of user ${request.params.userId}`)
}
},
})
```
## :arrow_forward: Route module definition
Method specification for attributes is available here: [Method specification](https://www.fastify.io/docs/latest/Routes/#full-declaration)
> :information_source: attributes `url` and `method` are dynamically provided
Allowed attributes mapped to Http methods in module:
- delete
- get
- head
- patch
- post
- put
- options
## :arrow_forward: Skipping files
to skip file in routes directory, prepend the `.` or `_` character to filename
examples:
```text
routes
├── .ignored-directory
├── _ignored-directory
├── .ignored-js-file.js
├── _ignored-js-file.js
├── .ignored-ts-file.ts
├── _ignored-ts-file.ts
├── ignored-js-test.test.js
└── ignored-ts-test.test.ts
```
> :warning: also any `*.test.js` and `*.test.ts` are skipped!
this 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
## :page_facing_up: License
Licensed under [MIT](./LICENSE)
## :sparkles: Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Giovanni Cardamone
💻 📖 💡 🚧
Gennaro
🎨
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.
Contributions of any kind welcome!