CRUD Controller

Overview
CRUD Controller provide a factory for creating CRUD endpoints based on ORM Module without coding.
The CRUD Controller was created for reduce boilerplate implementation of CRUD endpoints
​
CRUDControllerFactory
Using the CRUDControllerFactory we can create enpoints using an ORM Model, the ORM model should extend the @sugoi/ORM ModelAbstract
The CRUDControllerFactory  expose the of(model: ModelAbstract, options?: ICRUDOptions) method
Example
1
​
2
@ServerModule({
3
    controllers: [
4
        CRUDControllerFactory.of(MyModel) // Will create '/MyModel' uri based endpoints
5
    ],
6
    services: [],
7
    modules: []
8
})
9
export class Bootstrap {
10
}
Copied!
Endpoints
GET '/'
The GET endpoint without any parameter used for searching based on query parameters.
GET '/:id'
The GET endpoint with an id parameter used for query based on id.
POST '/'
The POST endpoint will create a new record in DB based on the request body.
PUT '/:id'
The PUT endpoint will update the record in DB based on the id with the request body.
DELETE '/:id'
The DELETE endpoint will delete the record from DB based on the id.
CRUDController Options
While creating a CRUD Controller we are able to pass some options to the factory for defining the endpoint, authorization, permissions and roles.
1
{
2
    endpoint?: string;
3
    authorized?: boolean;
4
    permissions?: Array<string | number>; 
5
    roles?: Array<string | number>;
6
}
Copied!
Example
1
@ServerModule({
2
    controllers: [
3
        CRUDControllerFactory.of(MyModel,{
4
            endpoint: '/MyModelCrud', 
5
            authorized: true, 
6
            roles: [ROLES.ADMIN, ROLES.AUTHOR],
7
        }) // Will create '/MyModelCrud' uri based endpoints
8
    ],
9
    services: [],
10
    modules: []
11
})
12
export class Bootstrap {
13
}
Copied!
Set allowed methods
By default all of the CRUD endpoints are toggled on, we can change it by using thesetAllowedMethods(...methods: Array<HTTP_METHOD> static method
Example
1
@ServerModule({
2
    controllers: [
3
        CRUDControllerFactory.of(MyModel).setAllowedMethods(
4
                                HTTP_METHOD.GET,
5
                                HTTP_METHOD.POST,
6
                                HTTP_METHOD.PUT
7
                            )
8
    ],
9
    services: [],
10
    modules: []
11
})
12
export class Bootstrap {
13
}
Copied!

Variable binding (Injection)

Next - @sugoi/server

Response handling

Last modified 2yr ago

Copy link

Contents

Overview

CRUDControllerFactory

Endpoints

CRUDController Options

Set allowed methods