Fast and low overhead web framework, for Node.js

Fastify version 1 was released on March 7th. This post will show you how to get it set up, and we’ll discuss some of the incredible features Fastify has to offer. No configuration is necessary — Fastify’s code base will run on Node versions 6.x, 8.x, and 9.x.

Ready?

Start with npm i fastify and then:

const fastify = require('fastify')()
fastify.get('/', (request, reply) => {  reply.send({ hello: 'world' })})
fastify.listen(3000, err => {  if (err) {    fastify.log.error(err)    process.exit(1)  }  fastify.log.info(    `server listening on ${fastify.server.address().port}`  )})

Now launch your server with: node server

🎉 That’s it! You’ve got your first Fastify server up and running.

What’s going on here?

const fastify = require('fastify')()

Line 1 is importing the Fastify framework into the JavaScript project and instantiating it. Your server instance is now stored in the fastify variable. You can pass additional options to this line like so:

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

Powered by the Pino logger, this option makes the console output easy to read and colorful. Check out the Pino documentation for more logger options, and the Fastify documentation for more Fastify instance options.

Next up: Routing

fastify.get('/', (request, reply) => {  reply.send({ hello: 'world' })})

Lines 3 through 5 define a very basic Route. Routes are the core to any Node.js backend server. Fastify supports two methods of defining routes: the shorthand method used above, or a general .route method as shown below.

fastify.route({  method: 'GET',  url: '/',  handler: function (request, reply) {    reply.send({ hello: 'world' })  }})

Both of these implementations do the exact same thing and have the same performance, so simply use whichever makes the most sense to you.

Route declaration has many more options available that aren’t shown here.

  • Provide a JSON Schema for the request and response objects, which can increase throughput by 10–20%
  • Define a beforeHandler method that is called just before the handler function. This is great for authentication, and I demonstrate how to use it in my JWT Auth plugin (more on Fastify plugins later).

Start your engines! 3…2…1…GO!

fastify.listen(3000, err => {  if (err) {    fastify.log.error(err)    process.exit(1)  }  fastify.log.info(    `server listening on ${fastify.server.address().port}`  )})

Finally, start the Fastify instance on localhost port 3000. This is the last step required to create your own Fastify instance. Internally this method will wait for .ready() (which is called after loading plugins). No new routes can be defined after calling the .listen() method.

Whats next? Plugins!

One of the best features of Fastify is how easy it is to write and incorporate plugins into a server instance. To start, define a function:

function superPlugin (fastify, opts, next) {  fastify.decorate('superMethod', () => {    console.log(`Secret code: ${opts.secretCode}`)  })  next()}

Now using the fastify-plugin module, export your new plugin.

const fp = require('fastify-plugin')
module.exports = fp(superPlugin, {  fastify: '>=1.0.0',  name: 'super-plugin'})

Finally register your plugin onto your Fastify instance:

/* Inside the main server.js file */const superPlugin = require('super-plugin')
fastify.register(superPlugin, {  secretCode: 'JavaScript is awesome!'})

Now you can call the superMethod anywhere you have access to your Fastify instance.

/* server.js */
fastify.listen(3000, err => {  fastify.superMethod()})

Just to note: you can register plugins within other plugins, which locks that child plugin’s scope to the parent plugin only. This topic is too advanced for this article, so I won’t be covering it any more detail. You can read more about Fastify plugins here. Check out the full example files in a Github gist here.

Go forth and conquer

Fastify is fast. Really really fast 🏎🔥

Fastify Benchmarks v1.1.x

After this brief introduction, I encourage you to check out all that Fastify has to offer. If you enjoy open source programming, Fastify is a great project to contribute to as well. There is also a great ecosystem of plugins to check out and contribute to!

Keep up the great work ~ Ethan Arrowood

Ethan Arrowood 🦉🇦🇺 (@ArrowoodTech) | Twitter
The latest Tweets from Ethan Arrowood 🦉🇦🇺 (@ArrowoodTech). always listening to music. probably contributing to open…twitter.com  Ethan-Arrowood (Ethan Arrowood)
Ethan-Arrowood has 80 repositories available. Follow their code on GitHub.github.com