# nest-rest-framework
Latest version **1.0.2** (published 2020-05-20) · MIT license · 0 weekly downloads
## Install
```sh
npm install nest-rest-framework
pnpm add nest-rest-framework
yarn add nest-rest-framework
bun add nest-rest-framework
```
## Health
**Score 25/100 (F)** — status: abandoned.
Positive: has types; no vulnerabilities; high quality score.
Warnings: low downloads; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.0.2 |
| Published | 2020-05-20 |
| First published | 2019-11-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 517.9 KB |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Maintainers | kerryritter |
| Keywords | nest, rest |
## Links
- npm: https://www.npmjs.com/package/nest-rest-framework
- Repository: https://github.com/kerryritter/nest-rest-framework
- Issues: https://github.com/kerryritter/nest-rest-framework
- npm.io page: https://npm.io/package/nest-rest-framework
## Dependencies (7)
- [rxjs](https://npm.io/package/rxjs.md) ^6.5.3
- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [rimraf](https://npm.io/package/rimraf.md) ^3.0.0
- [@nestjs/core](https://npm.io/package/@nestjs/core.md) ^6.7.2
- [@nestjs/common](https://npm.io/package/@nestjs/common.md) ^6.7.2
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13
- [@nestjs/platform-express](https://npm.io/package/@nestjs/platform-express.md) ^6.7.2
## Recent versions
- 1.0.2 (latest) — 2020-05-20
- 0.0.1 (alpha) — 2019-11-14
- 1.0.1 — 2020-01-28
- 1.0.0 — 2019-11-19
- 0.0.3 — 2019-11-14
- 0.0.2 — 2019-11-14
## README
Nest REST Framework is a toolkit for painlessly creating full-featured web APIs using the Nest framework. Inspired by Django REST Framework.
## Installation
*Coming Soon*
```bash
$ npm install --save nest-rest-framework nest-rest-framework-[typeorm|mongoose]
```
## Nest REST Framework Concepts
### Controllers
The foundational belief of the NRF design is that the controller should be as absent of code and logic as possible. The controller's job in this pattern is the wire together pieces that do the real work: ViewSets, Transformers, and Hooks.
### ViewSets
The duty of the viewset is to manage the interactions with the data storage layer by implementing the `ViewSet` base. This logic should be free of mapping logic (transformers) or business logic (hooks). **Future state intention** is that Nest REST Framework offers quick-start ViewSets for tools such as TypeORM and Mongoose.
### Transformers
Transformers are object mappers. NRF has two types of transformers: data transformers and request transformers. **Future state intention** is that these transformers are optional for use-cases such as prototypes or data-viewer style apps -- this will allow for a very quick spin-up of full REST APIs.
#### Data Transformers
Data transformers should map the stored data object into a web API-friendly response format. Typically these types of objects are JSON interfaces. *Input*: database object. *Output*: web API response.
#### Request Transformers
Request transformers should map the incoming data request into the stored data object. *Input*: web API request. *Output*: database object.
### Hooks
Hooks are event registrations for specific use-cases. NRF has three types of hooks: auth hooks, save hooks, and error hooks.
#### Auth Hooks
Auth hooks are responsible for validating the request for authorization and authentication. For instance, is the user logged in? Does this user have access to take CRUD actions against this particular entity? Can data only be managed on Tuesdays? Auth hooks are agnostic and allow for any sort of validation and verification.
### Save Hooks
Save hooks are executed whenever data changes are made.
### Error hooks
Error hooks are executed whenever an error occurs during the controller request lifecycle. Creating an error hook allows for functionality such as custom responses, support ticket logging, or process logging.
## Creating your first API
0. Create your data model class
```typescript
export class Todo {
id: number;
details: string;
complete: boolean;
```
1. Create a data transformer class.
```typescript
export class TodoDataTransformer extends Transformer {
transform(input: Todo): TodoDto {
const dto = {} as Todo;
dto.id = input.id;
dto.details = input.details;
dto.complete = input.complete;
return dto;
}
}
```
2. Create a request transformer class.
```typescript
export class TodoRequestTransformer extends Transformer {
transform(input: TodoDto): Todo {
const entity = new Todo();
entity.id = input.id;
entity.details = input.details;
entity.complete = input.complete;
return entity;
}
}
```
3. Create a viewset class.
```typescript
export class TodoViewSet extends ViewSet<
number,
Todo
> {
}
```
4. Create your controller.
```typescript
@Controller('todo')
export class TodoController extends RestController<
number,
Todo,
TodoDto,
TodoDto
> {
constructor(
viewset: TodoViewSet,
requestTransformer: TodoRequestTransformer,
dataTransformer: TodoDataTransformer,
) {
super({
enableBatch: true,
viewset,
requestTransformer,
dataTransformer,
});
}
}
```
## Support
Nest REST Framework is an MIT-licensed open source project.
## Committing
Committing to this project requires Commit messages to be formatted according to the Angular
[conventional-changelog](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)
## Stay in touch
- Author - [Kerry Ritter](https://kerryritter.com)
- Author - [Benjamin Main](mailto::bam036036@gmail.com)
- Nest Website - [https://nestjs.com](https://nestjs.com/)
- Twitter - [@kerryritter](https://twitter.com/kerryritter)
## License
Nest REST Framework is [MIT licensed](LICENSE).
---
_Source: https://npm.io/package/nest-rest-framework · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._