How to assign routes within a base route in fastify

Question

I am using fastify as a web framework in my nodejs project. I want to call all my routes from a directory having a base route defined in main JS file like we do in express. I have read many blogs but i did not find any relevant answer to my question

like in express we assign routes as-

app.use('/user', user_route)

and then in user_route we define all other routes method.

In fastify I have used

fastify.register(require('./routes/users'), { prefix: '/user' })

but then only one function can be called like-

module.exports = function (fastify, opts, done) {
  fastify.get('/user', handler_v1)
  done()
}

What if I want to call multiple route function?

Why do you think only one function can be called? Have you tried adding multiple `fastify.get(...)` or `fastify.post(..)`? — Molda, Aug 21 '19 at 11:30
Thanks It solved my problem. But is it the right way to declare routes? — ADITYA HAZARIKA, Aug 21 '19 at 13:43
There might be other ways to do it but I don't see anything wrong with this approach. — Molda, Aug 21 '19 at 15:57

score 11 · Answer 1 · answered May 14 '20 at 03:58

For the base route to work globally in all routes, you can register it in your server.js or app.js whatever you are using to register your server.

 fastify.register(require('../app/routes'), { prefix: 'api/v1' });

Here '../app/routes' points to your directory of routes. All routes that you define will be prefixed by 'api/v1'

Hope this helps.

score 8 · Answer 2 · answered Aug 28 '19 at 08:35

You can add many routes to a fastify instance like this:

'use strict'

const Fastify = require('fastify')
const fastify = Fastify({ logger: true })

fastify.register((instance, opts, next) => {

  instance.get('/', (req, res) => { res.send(req.raw.method) })
  instance.post('/', (req, res) => { res.send(req.raw.method) })
  instance.put('/', (req, res) => { res.send(req.raw.method) })
  instance.patch('/', (req, res) => { res.send(req.raw.method) })

  instance.get('/other', (req, res) => { res.send('other code') })

  next()
}, { prefix: 'user' })


fastify.listen(3000, () => {
  console.log(fastify.printRoutes());
})

The .register method is needed only to encapsulate context and plugins. This is useful to split your codebase into smaller files and load only the plugins you need.

In this way you will have a single route that replies different for different HTTP methods: curl -X GET http://localhost:3000/user/ or curl -X PUT http://localhost:3000/user/

This helped me a lot. Thank you!! – vijayakumarpsg587 Dec 30 '19 at 12:35 — vijayakumarpsg587, Dec 30 '19 at 12:35

score 6 · Answer 3 · edited Jul 17 '22 at 17:15

6

You can use the fastify-autoload plugin

const AutoLoad = require('fastify-autoload')
// define your routes in one of these
fastify.register(AutoLoad, {
    dir: path.join(__dirname, 'services'),
    options: Object.assign({ prefix: '/api' }, opts)
  })

edited Jul 17 '22 at 17:15

Abderrahim Soubai-Elidrisi

5,025
1
26
36

answered Aug 21 '19 at 14:21

saeid

61
2

score 4 · Answer 4 · answered Jan 27 '21 at 16:03

Fastify supports this even more organized way. I explain this step by step.

Create a directory name like routers
This directory may contain one or multiple .js files. Each file contains one or multiples routes. Like -

async function routes(fastify, options){
    fastify.get('/', async function(request, reply) {
         return {hello: 'world'} 
    }), 

    fastify.get('/bye', async function(request, reply) {
         return {bye: 'good bye'} 
    }) 
}

module.exports = routes

Next register this directory using fastify-autoload. Like

const path = require('path')
const autoload = require('fastify-autoload')

async function app(fastify, options){
    //old standard routing
    //fastify.register(require('./routes/baisc-router'))

    //auto-load, based on directory 
    fastify.register(autoload,{
         dir: path.join(__dirname, 'routes')
    })
}
module.exports = app

For clear details code, you can follow this Git repository.

How to assign routes within a base route in fastify

4 Answers4