探客时代
Fastify
Fast and low overhead web framework, for Node.js
README
[](https://github.com/fastify/fastify/actions/workflows/package-manager-ci.yml) [](https://github.com/fastify/fastify/actions/workflows/website.yml) 
[](https://www.npmjs.com/package/fastify) [](https://www.npmjs.com/package/fastify) [](https://github.com/fastify/fastify/blob/main/SECURITY.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?
- Install
- Example
- Support
- Team
- License
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.
This branch refers to the Fastify v4 release. Check out the
v3.x branch for v3.
Quick start
Create a folder and make it your current working directory:
- ```sh
- mkdir my-app
- cd my-app
- ```
Generate a fastify project with npm init:
- ```sh
- npm init fastify
- ```
Install dependencies:
- ```sh
- npm i
- ```
To start the app in dev mode:
- ```sh
- npm run dev
- ```
For production mode:
- ```sh
- npm start
- ```
Under the hood npm init downloads and runs [Fastify
Create](https://github.com/fastify/create-fastify), which in turn uses the
generate functionality of Fastify CLI.
Install
To install Fastify in an existing project as a dependency:
Install with npm:
- ```sh
- npm i fastify
- ```
Install with yarn:
- ```sh
- yarn add fastify
- ```
Example
- ``` js
- // 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:
- ``` js
- // 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 <a
href="./docs/Guides/Getting-Started.md">Getting Started.Fastify v1.x and v2.x
Code for Fastify's v1.x is in [`branch
1.x`](https://github.com/fastify/fastify/tree/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`](https://github.com/fastify/fastify/tree/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 to0.0.0.0. Be
careful when deciding to listen on all interfaces; it comes with inherent
[security
risks](https://web.archive.org/web/20170711105010/https://snyk.io/blog/mongodb-hack-and-secure-defaults/).
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](https://json-schema.org/) 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.3 | ✓ | 14,200 |
| hapi | 20.2.1 | ✓ | 42,284 |
| Restify | 8.6.1 | ✓ | 50,363 |
| Koa | 2.13.0 | ✗ | 54,272 |
| **Fastify** | **4.0.0** | **✓** | **77,193** |
|---|---|---|---|
| - | | | | | |
| `http.Server` | 16.14.2 | ✗ | 74,513 |
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<a
href="./docs/Reference/Encapsulation.md">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<a
href="./docs/Guides/Recommendations.md">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
[<img
src="https://github.com/openjs-foundation/artwork/blob/main/openjs_foundation/openjs_foundation-logo-horizontal-color.png?raw=true"
width="250px;"/>](https://openjsf.org/projects/#growth)
We are a [Growth
Project](https://github.com/openjs-foundation/cross-project-council/blob/HEAD/PROJECT_PROGRESSION.md#growth-stage)
in the OpenJS Foundation.
Acknowledgements
This project is kindly sponsored by:
- NearForm
Past Sponsors:
- LetzDoIt
This list includes all companies that support one or more of the team members
in the maintainance 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
