Framework aimed to provide useful TypeScript decorators to implement controllers, services and request handlers, built with Fastify.
npm install fastify-decorators
> Framework aimed to provide useful TypeScript decorators to implement controllers, services and request handlers, built with [Fastify].
- Fastify compatible - Built with [Fastify] and supports all its features and plugins
- JSON Schema validation - Build JSON Schemas to validate and speedup your requests and replies
- High performance - Framework adds as less overhead to Fastify as it can
- Highly customizable - Create your controllers, services and their methods as you wish
- 100% TypeScript - Written in TypeScript and comes with all the required typings
- Built-in DI - Provides simple Dependency Injection interface to bind your entries
- Getting started
- [Bootstrapping]
- [Controllers]
- [Request Handlers]
- [Services and dependency injection]
- [Testing]
- [Migration guide (V3)]
| Fastify Decorators | Fastify |
| :----------------: | :-------: |
| 1.x | 2.x |
| 2.x | 2.x |
| < 3.12.x | 3.x |
| >= 3.12.x | 3.x & 4.x |
| 4.x | 4.x |
- [JetBrains IDE plugin]
- [NestJS] - A progressive Node.js framework for building efficient, reliable and scalable server-side applications.
- [Fastify Resty] - Modern and declarative REST API framework for superfast and oversimplification backend development, build on top of Fastify and TypeScript.
Hello! Thank you for checking out fastify-decorators!
This documents aims to be gentle introduction to the fastify-decorators and its usages.
- Typescript
- Fastify
- typings for NodeJS (@types/node package installed)
Install with npm
``
npm i fastify-decorators --save
Install with yarn
`
yarn add fastify-decorators
Fastify-decorators requires experimentalDecorators feature to be enabled. For this you need to update your TypeScript config:
_tsconfig.json_:
`json`
{
"compilerOptions": {
"experimentalDecorators": true
}
}
_Note_: if you struggle which target please refer to table below:
| Node version | target |
| ------------ | ------ |
| 10.x | es2018 |
| 12.x | es2019 |
| 14.x | es2020 |
fastify-decorators itself use "target": "es2018" to support NodeJS 10+ (see [Node.js ES2018 Support]).
#### Request handler way
Let's write your first server with request handler:
_Project structure_:
`
├── index.ts
├── handlers
│ └── first.handler.ts
└── tsconfig.json
_index.ts_:
`ts
import { bootstrap } from 'fastify-decorators';
import { resolve } from 'path';
// Require the framework and instantiate it
const instance = require('fastify')();
// Register handlers auto-bootstrap
instance.register(bootstrap, {
// Specify directory with our handler
directory: resolve(__dirname, handlers),
// Specify mask to match only our handler
mask: /\.handler\./,
});
// Run the server!
instance.listen(3000);
`
_handlers/first.handler.ts_:
`ts
import { GET, RequestHandler } from 'fastify-decorators';
@GET({
url: '/hello',
})
export default class FirstHandler extends RequestHandler {
async handle() {
return 'Hello world!';
}
}
`
#### Controllers way
fastify-decorators also provides way to build controllers with multiple handlers:
_Project structure_:
`
├── index.ts
├── controllers
│ └── first.controller.ts
└── tsconfig.json
_index.ts_:
`ts
import { bootstrap } from 'fastify-decorators';
import { resolve } from 'path';
// Require the framework and instantiate it
const instance = require('fastify')();
// Register handlers auto-bootstrap
instance.register(bootstrap, {
// Specify directory with our controllers
directory: resolve(__dirname, controllers),
// Specify mask to match only our controllers
mask: /\.controller\./,
});
// Run the server!
instance.listen(3000);
`
_controllers/first.controller.ts_:
`ts
import { Controller, GET } from 'fastify-decorators';
@Controller({ route: '/' })
export default class FirstController {
@GET({ url: '/hello' })
async helloHandler() {
return 'Hello world!';
}
@GET({ url: '/goodbye' })
async goodbyeHandler() {
return 'Bye-bye!';
}
}
`
Also, we need to enable experimentalDecorators feature in our TypeScript config
_tsconfig.json_:
`json`
{
"compilerOptions": {
"experimentalDecorators": true
}
}
After all our files done we have to build server before we can run it:
1. Add to our package.json script to build server:
`
"scripts": {
"build": "tsc"
}
1. Run build script
With npm:
`
npm run build
with yarn:
`
yarn build
1. Start server
`
node index.ts
Awesome, that was easy.
[node.js es2018 support]: https://node.green/#ES2018
This project licensed under [MIT License]
[fastify]: https://npmjs.org/package/fastify
[jetbrains ide plugin]: https://plugins.jetbrains.com/plugin/13801-fastify-decorators
[mit license]: https://github.com/L2jLiga/fastify-decorators/blob/master/LICENSE
[nestjs]: https://nestjs.com/
[fastify resty]: https://github.com/FastifyResty/fastify-resty
[bootstrapping]: https://github.com/L2jLiga/fastify-decorators/blob/v3.16.1/docs/Bootstrapping.md
[controllers]: https://github.com/L2jLiga/fastify-decorators/blob/v3.16.1/docs/Controllers.md
[request handlers]: https://github.com/L2jLiga/fastify-decorators/blob/v3.16.1/docs/Request%20Handlers.md
[services and dependency injection]: https://github.com/L2jLiga/fastify-decorators/blob/v3.16.1/docs/Services%20and%20dependency%20injection.md
[testing]: https://github.com/L2jLiga/fastify-decorators/blob/v3.16.1/docs/Testing.md
[migration guide (v3)]: https://github.com/L2jLiga/fastify-decorators/blob/v3.16.1/docs/Migration%20to%20v3.md