fastify

To help you get started, we've collected the most common ways that fastify is being used within popular public projects.

xtremespb / zoia2 / src / shared / api / api.js View on Github

let pino;
    try {
        secure = await fs.readJSON(path.resolve(`${__dirname}/../etc/secure.json`));
        config = await fs.readJSON(path.resolve(`${__dirname}/../static/etc/config.json`));
        pino = Pino({
            level: secure.loglevel
        });
    } catch (e) {
        // eslint-disable-next-line no-console
        console.error(e);
        process.exit(1);
    }
    try {
        pino.info(`Starting`);
        // Create Fastify instance
        const fastify = Fastify({
            logger,
            trustProxy: secure.trustProxy
        });
        // Create Nodemailer instance
        const mailer = nodemailer.createTransport(secure.mailer);
        // Decorate Fastify with configuration and helpers
        fastify.decorate('zoiaConfig', config);
        fastify.decorate('zoiaConfigSecure', secure);
        fastify.decorateRequest('zoiaConfig', config);
        fastify.decorateRequest('zoiaConfigSecure', secure);
        fastify.decorate('zoiaMailer', mailer);
        fastify.decorateRequest('zoiaMailer', mailer);
        fastify.decorate('xxhash', data => xxhash(data, secure.randomInt));
        Object.keys(response).map(i => fastify.decorateReply(i, response[i]));
        Object.keys(loggerHelpers).map(i => fastify.decorateReply(i, loggerHelpers[i]));
        Object.keys(auth).map(i => fastify.decorateRequest(i, auth[i]));

View more ways to use fastify

An efficient server implies a lower cost of the infrastructure, a better responsiveness under load and happy users. How can you efficiently handle the resources of your server, knowing that you are serving the highest number of requests as possible, without sacrificing security validations and handy development?

Enter Fastify. Fastify is a web framework highly focused on providing the best developer experience with the least overhead and a powerful plugin architecture. It is inspired by Hapi and Express and as far as we know, it is one of the fastest web frameworks in town.

The main branch refers to the Fastify v5 release, which is not released/LTS yet. Check out the 4.x branch for v4.

Table of Contents

• Quick start
• Install
• Example
• Core features
• Benchmarks
• Documentation
• Ecosystem
• Support
• Team
• Hosted by
• License

Quick start

Create a folder and make it your current working directory:

mkdir my-app
cd my-app

Generate a fastify project with npm init:

npm init fastify

Install dependencies:

npm i

To start the app in dev mode:

npm run dev

For production mode:

npm start

Under the hood npm init downloads and runs Fastify Create, which in turn uses the generate functionality of Fastify CLI.

Install

To install Fastify in an existing project as a dependency:

Install with npm:

npm i fastify

Install with yarn:

yarn add fastify

Example

// Require the framework and instantiate it

// ESM
import Fastify from 'fastify'

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

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

// Run the server!
fastify.listen({ port: 3000 }, (err, address) => {
  if (err) throw err
  // Server is now listening on ${address}
})

with async-await:

// ESM
import Fastify from 'fastify'

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

fastify.get('/', async (request, reply) => {
  reply.type('application/json').code(200)
  return { hello: 'world' }
})

fastify.listen({ port: 3000 }, (err, address) => {
  if (err) throw err
  // Server is now listening on ${address}
})

Do you want to know more? Head to the Getting Started.

> ## Note > .listen binds to the local host, localhost, interface by default > (127.0.0.1 or ::1, depending on the operating system configuration). If > you are running Fastify in a container (Docker, > GCP, etc.), you may need to bind to 0.0.0.0. Be > careful when deciding to listen on all interfaces; it comes with inherent > security > risks. > See the documentation for more > information.

Core features

• Highly performant: as far as we know, Fastify is one of the fastest web frameworks in town, depending on the code complexity we can serve up to 76+ thousand requests per second.
• Extensible: Fastify is fully extensible via its hooks, plugins and decorators.
• Schema based: even if it is not mandatory we recommend to use JSON Schema to validate your routes and serialize your outputs, internally Fastify compiles the schema in a highly performant function.
• Logging: logs are extremely important but are costly; we chose the best logger to almost remove this cost, Pino!
• Developer friendly: the framework is built to be very expressive and help the developer in their daily use, without sacrificing performance and security.

Benchmarks

Machine: EX41S-SSD, Intel Core i7, 4Ghz, 64GB RAM, 4C/8T, SSD.

Method:: autocannon -c 100 -d 40 -p 10 localhost:3000 * 2, taking the second average

Benchmarks taken using https://github.com/fastify/benchmarks. This is a synthetic, "hello world" benchmark that aims to evaluate the framework overhead. The overhead that each framework has on your application depends on your application, you should always benchmark if performance matters to you.

Documentation

• Getting Started
• Guides
• Server
• Routes
• Encapsulation
• Logging
• Middleware
• Hooks
• Decorators
• Validation and Serialization
• Fluent Schema
• Lifecycle
• Reply
• Request
• Errors
• Content Type Parser
• Plugins
• Testing
• Benchmarking
• How to write a good plugin
• Plugins Guide
• HTTP2
• Long Term Support
• TypeScript and types support
• Serverless
• Recommendations

中文文档地址

Ecosystem

• Core - Core plugins maintained by the Fastify team.
• Community - Community supported plugins.
• Live Examples - Multirepo with a broad set of real working examples.
• Discord - Join our discord server and chat with the maintainers.

Support

Please visit Fastify help to view prior support issues and to ask new support questions.

Contributing

Whether reporting bugs, discussing improvements and new ideas or writing code, we welcome contributions from anyone and everyone. Please read the CONTRIBUTING guidelines before submitting pull requests.

Team

Fastify is the result of the work of a great community. Team members are listed in alphabetical order.

Lead Maintainers:

• Matteo Collina, ,
• Tomas Della Vedova, ,
• Manuel Spigolon, ,
• James Sumners, ,

Fastify Core team

• Tommaso Allevi, ,

• Harry Brundage, ,

• David Mark Clements, ,

• Matteo Collina, ,

• Tomas Della Vedova, ,

• Dustin Deus, ,

• Ayoub El Khattabi, ,

• Denis Fäcke, ,

• Carlos Fuentes, ,

• Vincent Le Goff

• Luciano Mammino, ,

• Luis Orbaiceta, ,

• Maksim Sinik, ,

• Manuel Spigolon, ,

• James Sumners, ,

• Aras Abbasi,

• Gürgün Dayıoğlu,

Fastify Plugins team

• Matteo Collina, ,

• Harry Brundage, ,

• Tomas Della Vedova, ,

• Ayoub El Khattabi, ,

• Carlos Fuentes, ,

• Vincent Le Goff

• Salman Mitha,

• Maksim Sinik, ,

• Frazer Smith,

• Manuel Spigolon, ,

• Simone Busoli, ,

• Gürgün Dayıoğlu,

• Dan Castillo,

• Jean Michelet,

Great Contributors

Great contributors on a specific area in the Fastify ecosystem will be invited to join this group by Lead Maintainers.

• dalisoft, ,

• Luciano Mammino, ,

• Evan Shortiss, ,

Past Collaborators

• Çağatay Çalı, ,
• Trivikram Kamat, ,
• Cemre Mengu, ,
• Nathan Woltman, ,
• Ethan Arrowood, ,
• Rafael Gonzaga, ,

Hosted by

We are a At-Large Project in the OpenJS Foundation.

Sponsors

Support this project by becoming a SPONSOR! Fastify has an Open Collective page where we accept and manage financial contributions.

Acknowledgements

This project is kindly sponsored by:

• NearForm
• Platformatic

Past Sponsors:

• LetzDoIt

This list includes all companies that support one or more of the team members in the maintenance of this project.

License

Licensed under MIT.

For your convenience, here is a list of all the licenses of our production dependencies:

• MIT
• ISC
• BSD-3-Clause
• BSD-2-Clause