Easy Express Endpoints

A simple and fast way to create API-endpoints for express, where each endpoint is it's own class.

Example

ExampleEndpoint.ts

1import { ValidationChain, body } from "express-validator";
2import { GetEndpoint, RequestData } from "easy-express-endpoints";
3
4type BodyData {
5  id: number;
6}
7
8export class ExampleEndpoint extends GetEndpoint {
9  constructor() {
10    super('/example/endpoint/path');
11    this.setAuthRequired(false);
12  }
13
14  protected getValidator(): ValidationChain[] {
15    return [
16      body('id').isInt({ min: 0 }).toInt()
17    ]
18  }
19
20  protected async execute(data: RequestData<BodyData>): Promise<void> {
21    // Handle request here
22    return "Hello world!";
23  }
24}

index.ts

1import express, { Router } from 'express';
2import http from 'http';
3
4const PORT = 3000;
5const app = express();
6const server = http.createServer(app);
7
8const apiRouter = Router();
9const endpoint = new ExampleEndpoint();
10endpoint.setupEndpoint(apiRouter);
11
12app.use('/api', apiRouter);
13server.listen(PORT);