Quick start#

Make your entities#

You're just going to have to create your TypeORM entities just like you always did. Then there are 2 @ decorators that are specific to entity-routes :

@EntityRoute which is a class decorator, must be placed at the top of it so that your entities can be exposed through an EntityRouter.
@Groups which is a property decorator, must be placed at the top of every properties you want to expose through your routes, more details on it later

Here is a simple example.

#typescript
1export class AbstractEntity {
2    @Groups("all")
3    @PrimaryGeneratedColumn()
4    id: number;
5}
6
7@EntityRoute({ path: "/users", operations: ["create", "update", "details", "list", "delete"] })
8@Entity()
9export class User extends AbstractEntity {
10    @Groups("basic")
11    @Column()
12    name: string;
13
14    @Subresource(() => Article)
15    @OneToMany(() => Article, (article) => article.author)
16    articles: Article[];
17}
18
19@EntityRoute()
20@Entity()
21export class Article extends AbstractEntity {
22    @Groups("basic")
23    @Column()
24    title: string;
25
26    @Groups("basic")
27    @Column()
28    content: string;
29
30    @Groups("basic")
31    @ManyToOne(() => User, (user) => user.articles)
32    author: User;
33}
Minimize

It will automatically generate those routes :

Verb	Path	Name
POST	/users	user_create
POST	/users/mapping	user_create_mapping
PUT	/users/:id(\d+)	user_update
PUT	/users/:id(\d+)/mapping	user_update_mapping
GET	/users/:id(\d+)	user_details
GET	/users/:id(\d+)/mapping	user_details_mapping
GET	/users	user_list
GET	/users/mapping	user_list_mapping
DELETE	/users/:id(\d+)	user_delete
POST	/users/:UserId(\d+)/articles	user_articles_create
GET	/users/:UserId(\d+)/articles	user_articles_list
DELETE	/users/:UserId(\d+)/articles/:id(\d+)	user_articles_delete

Register your Entity Routes#

#typescript
1import { AddressInfo } from "net";
2import { makeKoaEntityRouters } from "@entity-routes/koa";
3import * as Koa from "koa";
4import * as bodyParser from "koa-bodyparser";
5import { Connection } from "typeorm";
6export async function setupKoaApp(connection: Connection) {
7    const entities = connection.entityMetadatas.map((meta) => meta.target) as Function[];
8    const bridgeRouters = await makeKoaEntityRouters({ connection, entities, options });
9
10    const app = new Koa();
11    app.use(bodyParser());
12
13    // Register all routes on koa server
14    bridgeRouters.forEach((router) => app.use(router.instance.routes()));
15
16    const server = app.listen(); / random port
17    const baseURL = `http://127.0.0.1:${(server.address() as AddressInfo).port}`;
18
19    return { baseURL, server };
20}

#typescript
1import { AddressInfo } from "net";
2import { makeExpressEntityRouters } from "@entity-routes/express";
3import * as bodyParser from "body-parser";
4import * as express from "express";
5import { Connection } from "typeorm";
6export async function setupExpressApp(connection: Connection) {
7    const entities = connection.entityMetadatas.map((meta) => meta.target) as Function[];
8    const bridgeRouters = await makeExpressEntityRouters({ connection, entities, options });
9
10    const app = express();
11    app.use(bodyParser.json());
12    app.use(bodyParser.urlencoded({ extended: true }));
13
14    // Register all routes on Express server
15    bridgeRouters.forEach((router) => app.use(router.instance));
16
17    const server = app.listen(); / random port
18    const baseURL = `http://127.0.0.1:${(server.address() as AddressInfo).port}`;
19
20    return { baseURL, server };
21}

Final step#

That's it. There is no final step. Your routes are ready.

Move on to learn more about entity-routes.

While browsing the documentation, if you feel like an example is missing, feel free to check the tests folder to see the actual usage of the feature you were reading about.

Installation

Introduction