File-based routing plugin for fastify. Inspired from fastify-autoroutes.
src/
├── server.ts
└── routes/
├── index.ts (ALL)
├── post.ts (POST)
└── nested/
└── route.ts (GET | POST | PUT | DELETE)
npm install --save @lynithdev/fastify-filerouting
⚠️ Files ending with.test.jsor.test.tsor starting with_or.get ignored by the router
import fastify from "fastify";
import fileRouting from "@lynithdev/fastify-filerouting";
const server = fastify({
ignoreTrailingSlash: true // Recommended
});
server.register(fileRouting, {
dir: "./routes" // Required
prefix: "" // Optional
});import { createRoute } from "@lynithdev/fastify-filerouting";
export default createRoute({
schema: {
params: Type.Object({
name: Type.String(),
}),
},
handler: (req, res) => {
// Type inference if using type providers
// (with support for type validation as well!)
res.send(req.params.name);
}
});import { createRoutes, createRoute } from "@lynithdev/fastify-filerouting";
export default createRoutes({
get: createRoute({
schema: {
params: Type.Object({
name: Type.String(),
}),
},
handler: (req, res) => {
// Type inference if using type providers
// (with support for type validation as well!)
res.send(req.params.name);
}
}),
post: createRoute({
handler: (req, res) => {
res.send(req.body);
}
})
});I've only managed to find one way of overriding the type provider (for the route schema). (If anyone knows a better way, please create an issue)
(Example using fastify-type-provider-typebox)
import { FastifySchema } from 'fastify';
import { TypeBoxTypeProvider } from '@fastify/type-provider-typebox';
import { type Route, createRoute as _createRoute } from '@lynithdev/fastify-filerouting';
export const createRoute = <Schema extends FastifySchema>(opts: Route<Schema, TypeBoxTypeProvider>) => _createRoute<Schema, TypeBoxTypeProvider>(opts);After you've done that, use your new exported function instead of the library's exported function.
This project is licensed under MIT