Björn
b963b3396c
|
5 years ago | |
---|---|---|
.. | ||
.dependabot | 5 years ago | |
build | 5 years ago | |
docs | 5 years ago | |
examples | 5 years ago | |
lib | 5 years ago | |
test | 5 years ago | |
LICENSE | 5 years ago | |
README.md | 5 years ago | |
SECURITY.md | 5 years ago | |
fastify.d.ts | 5 years ago | |
fastify.js | 5 years ago | |
package.json | 5 years ago |
README.md
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.
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
fastify.log.info(`server 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
fastify.log.info(`server listening on ${address}`)
})
Do you want to know more? Head to the Getting Started
.
Fastify v1.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
.
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 to0.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 |
---|---|---|---|
hapi | 18.1.0 | ✓ | 29,998 |
Express | 4.16.4 | ✓ | 38,510 |
Restify | 8.0.0 | ✓ | 39,331 |
Koa | 2.7.0 | ✗ | 50,933 |
Fastify | 2.0.0 | ✓ | 76,835 |
- | |||
http.Server |
10.15.2 | ✗ | 71,768 |
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
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.
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:
- Matteo Collina, https://twitter.com/matteocollina, https://www.npmjs.com/~matteo.collina
- Tomas Della Vedova, https://twitter.com/delvedor, https://www.npmjs.com/~delvedor
Fastify Core team
- Tommaso Allevi, https://twitter.com/allevitommaso, https://www.npmjs.com/~allevo
- Ethan Arrowood, https://twitter.com/arrowoodtech, https://www.npmjs.com/~ethan_arrowood
- David Mark Clements, https://twitter.com/davidmarkclem, https://www.npmjs.com/~davidmarkclements
- Matteo Collina, https://twitter.com/matteocollina, https://www.npmjs.com/~matteo.collina
- Tomas Della Vedova, https://twitter.com/delvedor, https://www.npmjs.com/~delvedor
- Dustin Deus, https://twitter.com/dustindeus, https://www.npmjs.com/~starptech
- Denis Fäcke, https://twitter.com/serayaeryn, https://www.npmjs.com/~serayaeryn
- Luciano Mammino, https://twitter.com/loige, https://www.npmjs.com/~lmammino
- Cemre Mengu, https://twitter.com/cemremengu, https://www.npmjs.com/~cemremengu
- Manuel Spigolon, https://twitter.com/manueomm, https://www.npmjs.com/~eomm
- James Sumners, https://twitter.com/jsumners79, https://www.npmjs.com/~jsumners
Fastify Plugins team
- Matteo Collina, https://twitter.com/matteocollina, https://www.npmjs.com/~matteo.collina
- Tomas Della Vedova, https://twitter.com/delvedor, https://www.npmjs.com/~delvedor
- Manuel Spigolon, https://twitter.com/manueomm, https://www.npmjs.com/~eomm
Collaborators
Great contributors on a specific area in the Fastify ecosystem will be invited to join this group by Lead Maintainers.
- Luciano Mammino, https://twitter.com/loige, https://www.npmjs.com/~lmammino
- Evan Shortiss, https://twitter.com/evanshortiss, https://www.npmjs.com/~evanshortiss
Past Collaborators
- Çağatay Çalı, https://twitter.com/cagataycali, https://www.npmjs.com/~cagataycali
- Trivikram Kamat, https://twitter.com/trivikram, https://www.npmjs.com/~trivikr
- Nathan Woltman, https://twitter.com/NathanWoltman, https://www.npmjs.com/~nwoltman
Hosted by
We are currently an incubated project at the OpenJS Foundation.
Acknowledgements
This project is kindly sponsored by:
Past Sponsors:
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