A progressive Node.js framework for building efficient and scalable server-side applications.

Simple Blog API (CRUD users, users CRUD posts)

nestjsx-crud TypeORM Fastify REST API

Nest TypeScript starter repository with NestJs CRUD for RESTful APIs and Fastify.

Installation

$ pnpm install

Running the app

# development
$ pnpm run start

# watch mode
$ pnpm run start:dev

# production mode
$ pnpm run start:prod

Test

# unit tests
$ pnpm run test

# e2e tests
$ pnpm run test:e2e

# test coverage
$ pnpm run test:cov

API Endpoints

nestjsx/crud Crud() decorator generates the following API endpoints:

Get many resources

GET /users
GET /posts

Result: array of resources | pagination object with data, Status Codes: 200

Get one resource

GET /users/:id
GET /posts/:id

Request Params: :id - some resource field (slug), Result: resource object | error object, Status Codes: 200 | 404

Create one resource

POST /users
POST /posts

Request Body: resource object | resource object with nested (relational) resources, Result: created resource object | error object, Status Codes: 201 | 400

Update one resource

PATCH /users/:id
PATCH /posts/:id

Request Params: :id - some resource field (slug), Request Body: resource object (or partial) | resource object with nested (relational) resources (or partial), Result: updated partial resource object | error object, Status codes: 200 | 400 | 404

Delete one resource

DELETE /users/:id
DELETE /posts/:id

Request Params: :id - some resource field (slug), Result: empty | resource object | error object Status codes: 200 | 404

License

This repo is MIT licensed.

Related Projects

• Refine Boilerplate for Web (PWA), Desktop and Mobile — A Cross-Platform starter template for Refine.dev that utilizes the Simple REST data provider to fetch and display data from a REST API (can easily replace with graphql data provider).