The Declarative GraphQL API Library

DryerJS, leveraging the power of NestJS and Mongoose, automates the creation of CRUD GraphQL APIs from model declarations. It supports complex model relationships and offers extensive customization options, greatly reducing repetitive coding and enhancing development efficiency.

Getting Started

To get started with DryerJS, follow these steps:

Prepare:

# initialize a new Nest project
npm i -g @nestjs/cli && nest new my-project && cd my-project
# install standard dependencies
npm i @nestjs/graphql @nestjs/apollo @nestjs/mongoose
# install peer dependencies
npm i dataloader class-transformer class-validator
# remove unrelated files
npm run env -- rimraf src/app.(service|controller)*

Install DryerJS:

npm i dryerjs

Declare your first model on src/user.ts:

import { Definition, Property, Id, Skip, ObjectId } from 'dryerjs';
 
@Definition()
export class User {
  @Id()
  id: ObjectId;
 
  @Property()
  email: string;
 
  @Property({ update: Skip, output: Skip })
  password: string;
 
  @Property()
  name: string;
}

Import your model and DryerJSModule in AppModule with other modules inside app.module.ts:

import { Module } from '@nestjs/common';
import { GraphQLModule } from '@nestjs/graphql';
import { ApolloDriver, ApolloDriverConfig } from '@nestjs/apollo';
import { MongooseModule } from '@nestjs/mongoose';
import { DryerModule } from 'dryerjs';
 
import { User } from './user';
 
@Module({
  imports: [
    GraphQLModule.forRoot<ApolloDriverConfig>({
      driver: ApolloDriver,
      autoSchemaFile: true,
      playground: true,
    }),
    MongooseModule.forRoot('mongodb://127.0.0.1:27017/test'),
    DryerModule.register({ definitions: [User] }),
  ],
})
export class AppModule {}

Start the server

npm run start:dev

Open browser and go to http://localhost:3000/graphql (opens in a new tab) to see the GraphQL playground.

Sample requests

mutation CreateUser {
  createUser(input: {
    email: "[email protected]"
    name: "Admin"
    password: "ChangeMe123!"
  }) {
    id
    email
    name
  }
}

mutation UpdateUser {
  updateUser(input: {
    id: "<<SOME_MONGO_OBJECT_ID>>"
    name: "Super Admin"
  }) {
    id
    email
    name
  }
}

query PaginateUsers {
  paginateUsers(limit: 10, page: 1) {
    docs {
      email
      id
      name
    }
    limit
    page
    pagingCounter
    totalDocs
    totalPages
    hasPrevPage
    hasNextPage
  }
}

query User {
  user(id: "<<SOME_MONGO_OBJECT_ID>>") {
    id
    email
    name
  }
}

mutation RemoveUser {
  removeUser(id: "<<SOME_MONGO_OBJECT_ID>>") {
    success
  }
}

CRUD APIs