Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fastifyresty/fastify-resty
⚔️ Declarative NodeJS web framework with REST API route auto-generation, DI, and decorators, build on top of Fastify and TypeScript.
https://github.com/fastifyresty/fastify-resty
api decorators fastify framework json-schema nodejs rest typescript
Last synced: 24 days ago
JSON representation
⚔️ Declarative NodeJS web framework with REST API route auto-generation, DI, and decorators, build on top of Fastify and TypeScript.
- Host: GitHub
- URL: https://github.com/fastifyresty/fastify-resty
- Owner: FastifyResty
- License: mit
- Created: 2020-10-30T21:41:11.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-21T20:06:47.000Z (8 months ago)
- Last Synced: 2024-10-12T15:30:53.292Z (24 days ago)
- Topics: api, decorators, fastify, framework, json-schema, nodejs, rest, typescript
- Language: TypeScript
- Homepage:
- Size: 1.18 MB
- Stars: 83
- Watchers: 1
- Forks: 9
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://codecov.io/gh/FastifyResty/fastify-resty)
[](https://snyk.io/test/github/FastifyResty/fastify-resty)
[](https://depfu.com/github/FastifyResty/fastify-resty?project_id=17745)
[](https://github.com/Naereen/StrapDown.js/blob/master/LICENSE)
[](https://GitHub.com/FastifyResty/fastify-resty/graphs/commit-activity)
[](https://lerna.js.org/)
> **Modern and declarative REST API framework for superfast and oversimplification backend development, build on top of Fastify and TypeScript.**
If you find this useful, please don't forget to star :star: the repo, as this will help to promote the project.
## Benefits :dart:
- **Zero configuration** - Generates [RESTful API](https://restfulapi.net/) routes for your data out the box
- **JSON Schema validation** - Build [JSON Schemas](https://json-schema.org/) to validate and speedup your requests and replies
- **Highly customizable** - provides a lot of possible configurations for your application
- **Purely TypeScript** - Written in [TypeScript](https://www.typescriptlang.org/) and comes with all the required typings
- **Declarative interface** - Uses decorators for routes and models definitions
- **Fastify compatible** - Built with [Fastify](https://www.fastify.io/) and supports all its features and plugins
- **Built-in DI** - Provides simple Dependency Injection interface to bind your entries
## Install :pushpin:
#### Core module
```sh
$ npm install @fastify-resty/core fastify
```
#### TypeORM connector
```sh
$ npm install @fastify-resty/typeorm typeorm
```
## Usage :rocket:
##### TypeORM Entity (author.entity.ts):
```ts
import { Entity, Column, PrimaryGeneratedColumn, CreateDateColumn } from 'typeorm';
@Entity()
export default class Author {
@PrimaryGeneratedColumn()
id: number;
@Column()
firstname: string;
@Column()
lastname: string;
@CreateDateColumn()
created_at: Date;
}
```
##### Entity controller (author.controller.ts):
```ts
import { EntityController } from '@fastify-resty/core';
import AuthorEntity from './author.entity';
@EntityController(AuthorEntity, '/authors')
export default class AuthorController {}
```
##### Bootstrap (app.ts):
```ts
import fastify from 'fastify';
import { createConnection } from 'typeorm';
import { bootstrap } from '@fastify-resty/core';
import typeorm from '@fastify-resty/typeorm';
import AuthorController from './author.controller';
async function main() {
const app = fastify();
const connection = await createConnection();
app.register(typeorm, { connection });
app.register(bootstrap, { controllers: [AuthorController] });
app.listen(8080, (err, address) => {
console.log(app.printRoutes());
});
}
main();
```
##### Generated routes:
```
└── /
└── users (DELETE|GET|PATCH|POST|PUT)
└── / (DELETE|GET|PATCH|POST|PUT)
└── :id (DELETE)
:id (GET)
:id (PATCH)
:id (PUT)
```
## Documentation :books:
- [Quickstart](./docs/Quickstart.md) :label:
- [Application Structure](./docs/Application-Structure.md) :label:
- [Bootstrapping](./docs/Bootstrapping.md) :label:
- [Controllers](./docs/Controllers.md) :label:
- [Entity Controllers](./docs/Entity-Controllers.md) :label:
- [Model](./docs/Model.md) :label:
- [Services](./docs/Services.md) :label:
- [Dependency Injection](./docs/Dependency-Injection.md) :label:
## Packages :package:
- [@fastify-resty/core](https://www.npmjs.com/package/@fastify-resty/core) - **Fastify Resty** core functionality
- [@fastify-resty/typeorm](https://www.npmjs.com/package/@fastify-resty/typeorm) - **Fastify Resty** TypeORM connector
## Examples :microscope:
- [Fastify Resty Quickstart](https://github.com/FastifyResty/fastify-resty/tree/main/examples/fastify-resty-quickstart)
- [Fastify Resty Blog API](https://github.com/FastifyResty/fastify-resty/tree/main/examples/fastify-resty-blog)
## Issues and contributions :memo:
Contributors are welcome, please fork and send pull requests! If you find a bug or have any ideas on how to improve this project please submit an issue.
## License
[MIT License](https://github.com/FastifyResty/fastify-resty/blob/main/LICENSE.md)
Icons made by Eucalyp from www.flaticon.com