lasintez-fastify-but-i-just-test-readme

v3.15.0

Published

3 years ago

Fast and low overhead web framework, for Node.js

Downloads

0High
0Medium
0Low

lasintez

web framework json schema open api

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.

Requirements

Node.js v10 LTS (10.16.0) or later.

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 install

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

If installing in an existing project, then Fastify can be installed into the project as a dependency:

Install with npm:

npm i fastify --save

Install with yarn:

yarn add fastify

Example

// Require the framework and instantiate it
const fastify = require('fastify')({
  logger: true
})

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

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

with async-await:

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

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

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

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

Fastify v1.x and v2.x

Code for Fastify's v1.x is in branch 1.x, so all Fastify 1.x related changes should be based on branch 1.x. In a similar way, all Fastify v2.x related changes should be based on branch 2.x.

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.
Extendible: 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

| Framework | Version | Router? | Requests/sec | | :----------------- | :------------------------- | :----------: | ------------: | | Express | 4.17.1 | ✓ | 15,978 | | hapi | 19.1.0 | ✓ | 45,815 | | Restify | 8.5.1 | ✓ | 49,279 | | Koa | 2.13.0 | ✗ | 54,848 | | Fastify | 3.0.0 | ✓ | 78,956 | | - | | | | | http.Server | 12.18.2 | ✗ | 70,380 |

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
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.

Team

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

Lead Maintainers:

Fastify Core team

Fastify Plugins team

Great Contributors

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

Past Collaborators

Hosted by

We are a Growth Project in the OpenJS Foundation.

Acknowledgements

This project is kindly sponsored by:

nearForm

Past Sponsors:

LetzDoIt

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