fastify
Advanced tools
Package description
Fastify is a fast and low overhead web framework for Node.js. It is highly performant and provides an extensive plugin architecture, making it suitable for building a wide range of server-side applications and services.
Web Server
Fastify allows you to create a web server that can handle HTTP requests and send responses. The above code demonstrates setting up a simple server that responds with JSON when the root route is accessed.
const fastify = require('fastify')({ logger: true });
fastify.get('/', async (request, reply) => {
return { hello: 'world' };
});
fastify.listen(3000, (err, address) => {
if (err) throw err;
fastify.log.info(`server listening on ${address}`);
});Route Shorthand Methods
Fastify provides shorthand methods for different HTTP methods like GET, POST, etc. This makes it easy to define routes for various request types.
fastify.get('/example', (request, reply) => {
reply.send({ message: 'This is a GET request' });
});
fastify.post('/example', (request, reply) => {
reply.send({ message: 'This is a POST request' });
});Schema Validation
Fastify supports schema validation for request payloads, query strings, and parameters using JSON Schema. This ensures that the data received is in the expected format.
const schema = {
body: {
type: 'object',
required: ['name'],
properties: {
name: { type: 'string' },
age: { type: 'number' }
}
}
};
fastify.post('/user', { schema }, (request, reply) => {
// Handle request knowing that the body has been validated against the schema
});Plugins
Fastify has a powerful plugin system that allows you to extend its core functionality. Plugins can add new features, routes, services, and decorators to the Fastify instance.
const myPlugin = async (fastify, options) => {
fastify.decorate('utility', () => {
return 'something useful';
});
};
fastify.register(myPlugin);
// Now you can use fastify.utility() in your applicationLifecycle Hooks
Fastify provides lifecycle hooks that can be used to execute code at various stages of the request/response cycle, such as onRequest, preHandler, onResponse, etc.
fastify.addHook('onRequest', (request, reply, done) => {
// Perform some operations before the request handler is executed
done();
});Express is one of the most popular web frameworks for Node.js. It is known for its simplicity and minimalism. Compared to Fastify, Express has a larger ecosystem and community but may not be as performant due to its less optimized architecture.
Koa is a web framework designed by the creators of Express, aiming to be a smaller, more expressive, and more robust foundation for web applications and APIs. Koa uses async functions to eliminate callbacks and improve error handling. It is less opinionated than Fastify and has a smaller footprint.
Hapi is a rich framework for building applications and services, known for its powerful plugin system. It is designed to be more configurable and to provide a richer set of features out of the box compared to Fastify, which can make it heavier and potentially slower.
Restify is a Node.js web service framework optimized for building semantically correct RESTful web services ready for production use at scale. Restify is similar to Fastify in terms of performance but is more focused on API creation than being a general-purpose web framework.
Readme
Extremely fast node.js web framework, inspired by Express, Hapi and Restify.
Fastify is alpha software in active development, feel free to contribute!
npm install fastify --save
'use strict'
const fastify = require('fastify')()
const http = require('http')
const server = http.createServer(fastify)
const schema = {
out: {
type: 'object',
properties: {
hello: {
type: 'string'
}
}
}
}
fastify
.get('/', schema, function (req, reply) {
reply(null, { hello: 'world' })
})
.get('/no-schema', function (req, reply) {
reply(null, { hello: 'world' })
})
.post('/', schema, function (req, reply) {
reply(null, { hello: 'world' })
})
server.listen(8000, function (err) {
if (err) {
throw err
}
console.log(`server listening on ${server.address().port}`)
})
As far as we know, it is one of the fastest web frameworks in town:
All benchmarks where average taken over 5 seconds, on the second run of autocannon -c 100 -d 5 -p 10 localhost:3000.
Returns a new fastify instance, which is a function with some method
attached. req and res are the request and response objects from Node
Core.
const fastify = require('fastify')()
const http = require('http')
const server = http.createServer(fastify)
server.listen(8000, function (err) {
if (err) {
throw err
}
console.log(`server listening on ${server.address().port}`)
})
Options:
method: currently it supports only GET, POST and PUT.
url: the path of the url to match this route, it uses
wayfarer as a router.
schema: an object containing the schemas for the request and response. They need to be in
[JSON Schema][jsonschema] format:
payload: validates the body of the request if it is a POST or a
PUT. It uses ajv.querystring: validates the querystring. It uses ajv.params: validates the params. It uses ajv.out: filter and generate a schema for the response, setting a
schema allows us to have 10-20% more throughput. It uses
fast-json-stringify.handler(request, repy(err, statusCode, object): the function that will handle this request.
The request parameter is defined in Request.
object inside the request is a JavaScript object that will be
JSONified, possibly using the schema defined options.schema.out.
For POST and PUT, the incoming request body will be parsed.
An object including the following properties:
query - the parsed querystringbody - the bodyparams - the params matching the URLreq - the incoming HTTP request from Node coreCalls route with the given path, schemas and handler, setting up the GET method.
Calls route with the given path, schemas and handler, setting up the POST method.
Calls route with the given path, schemas and handler, setting up the PUT method.
Used to register one or more plugins.
plugin can be a single function or an array of functions.
In case of the array of functions, the same options object and callback will be passed to them.
boot-in-the-arse is used to load the plugins.
Example:
// server.js
const fastify = require('fastify')()
const http = require('http')
const server = http.createServer(fastify)
fastify.register(require('./plugin'), function (err) {
if (err) throw err
})
const opts = {
hello: 'world',
something: true
}
fastify.register([
require('./another-plugin')
require('./yet-another-plugin')
], opts, function (err) {
if (err) throw err
})
server.listen(8000, function (err) {
if (err) {
throw err
}
console.log(`server listening on ${server.address().port}`)
})
// plugin.js
module.exports = function (fastify, options, next) {
fastify.get('/', schema, function (req, reply) {
reply(null, { hello: 'world' })
})
next()
}
https://www.npmjs.com/~matteo.collina
https://twitter.com/matteocollina
https://www.npmjs.com/~delvedor
This project was kindly sponsored by nearForm.
Licensed under MIT.
FAQs
Fast and low overhead web framework, for Node.js
We found that fastify demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.