Added tsoa

package.json

@@ -10,13 +10,14 @@
   "scripts": {
     "dev": "ts-node src/server.ts",
     "start": "ts-node dist/src/server.js",
-    "build": "tsc -p . -w > /dev/null 2>&1 &",
+    "build": "tsc -p . -w > /dev/null 2>&1 & tsoa spec-and-routes",
     "lint": "eslint . --ext .ts",
     "test": "jest",
     "test:unit": "NODE_ENV=test jest --testPathPattern=\"__tests__/unit/*/*/\"",
     "test:e2e": "NODE_ENV=test jest --testPathPattern=\"__tests__/e2e/*/*/\"",
     "prepare": "husky install",
-    "clean" : "npx depcheck"
+    "clean": "npx depcheck",
+    "routes": "tsoa spec-and-routes"
   },
   "author": "Mustafa Erdem Köşk",
   "license": "ISC",
@@ -32,6 +33,7 @@
     "swagger-jsdoc": "^6.1.0",
     "swagger-ui-express": "^4.6.2",
     "ts-node": "^8.4.1",
+    "tsoa": "^6.1.5",
     "tsyringe": "^4.7.0",
     "typescript": "^4.9.5",
     "winston": "^3.8.2"

src/app.ts

@@ -1,27 +1,33 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-import * as express from 'express';
 import 'express-async-errors';
-import { Application } from 'express';
-import * as swaggerUi from 'swagger-ui-express';
-import { swaggerSpec } from './util/swagger.util';
+import express, {
+  Application,
+  Response as ExResponse,
+  Request as ExRequest,
+} from 'express';
+import swaggerUi from 'swagger-ui-express';
 import Logger from './util/logger.util'
+import { RegisterRoutes } from '../dist/routes';
+// import { container } from './ioc';
 
 class App {
   public app: Application;
 
   public port: number;
 
   constructor(
-    appInit: { port: number; earlyMiddlewares: any; lateMiddlewares: any; routes: any; },
+    appInit: { port: number; earlyMiddlewares: any; lateMiddlewares: any;},
   ) {
     this.app = express();
     this.port = appInit.port;
 
+    this.modules();
     this.middlewares(appInit.earlyMiddlewares);
-    this.routes(appInit.routes);
+    this.routes();
     this.middlewares(appInit.lateMiddlewares);
     this.assets();
     this.template();
+    this.swagger();
   }
 
   private middlewares(middlewares: { forEach: (arg0: (middleware: any) => void) => void; }) {
@@ -30,14 +36,6 @@ class App {
     });
   }
 
-  private routes(routes: { forEach: (arg0: (route: any) => void) => void; }) {
-    routes.forEach((route) => {
-      this.app.use('/', route.router);
-    });
-
-    this.app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec));
-  }
-
   // eslint-disable-next-line @typescript-eslint/no-empty-function
   private assets() {
   }
@@ -46,6 +44,24 @@ class App {
   private template() {
   }
 
+  private modules() {
+    // container.resolve<IMongoLoader>('IMongoLoader').ConnectWithRetry();
+  }
+
+  private routes() {
+    RegisterRoutes(this.app);
+  }
+
+  private swagger() {
+    this.app.use(
+      '/swagger',
+      swaggerUi.serve,
+      async (_req: ExRequest, res: ExResponse) => res.send(
+        swaggerUi.generateHTML(await import('../dist/swagger.json')),
+      ),
+    );
+  }
+
   public listen() {
     this.app.listen(this.port, () => {
       Logger.info(`App listening on the http://localhost:${this.port}`);

src/interfaces/repository/IExampleRepository.ts

@@ -0,0 +1,5 @@
+import { ExampleRequest, ExampleResponse } from '../../modules/example/dtos/Example';
+
+export interface IExampleRepository {
+  getExample(id:number): Promise<ExampleResponse>;
+}

src/interfaces/service/IExampleService.ts

@@ -0,0 +1,5 @@
+import { ExampleRequest, ExampleResponse } from '../../modules/example/dtos/Example';
+
+export interface IExampleService {
+  getExample(id:number): Promise<ExampleResponse>;
+}

src/ioc/index.ts

@@ -0,0 +1,15 @@
+import { IocContainer } from '@tsoa/runtime';
+import { container } from 'tsyringe';
+
+import ExampleRepository from '../modules/example/ExampleRepository';
+import ExampleService from '../modules/example/ExampleService';
+
+container.register('IExampleService', { useClass: ExampleService });
+container.register('IExampleRepository', { useClass: ExampleRepository });
+
+// eslint-disable-next-line max-len
+export const iocContainer: IocContainer = { get: <T>(controller: { prototype: T }): T => container.resolve<T>(controller as never) };
+
+export { container };
+
+export default iocContainer;

src/modules/example/ExampleController.ts

@@ -0,0 +1,33 @@
+import { inject, injectable } from 'tsyringe';
+import {
+  Body,
+  Controller,
+  Get,
+  Post,
+  Put,
+  Request,
+  Route,
+  Security,
+  Tags,
+  Response,
+} from 'tsoa';
+import { IExampleService } from '../../interfaces/service/IExampleService';
+import { ExampleRequest, ExampleResponse } from './dtos/Example';
+
+@injectable()
+@Route('example')
+@Tags('ExampleController')
+export class ExampleController extends Controller {
+  constructor(
+    @inject('IExampleService') private exampleService: IExampleService,
+  ) {
+    super();
+  }
+
+  @Get('/{id}')
+  get(id: number): Promise<ExampleResponse> {
+    return this.exampleService.getExample(id);
+  }
+}
+
+export default { ExampleController };

src/modules/example/ExampleRepository.ts

@@ -0,0 +1,23 @@
+import { IExampleRepository } from '../../interfaces/repository/IExampleRepository';
+import { ExampleRequest, ExampleResponse, Example } from './dtos/Example';
+
+export default class ExampleRepository implements IExampleRepository {
+  getExample(id:number): Promise<ExampleResponse> {
+    const examples: Example[] = [{
+      id: 1,
+      name: 'erdem',
+    },
+    {
+      id: 2,
+      name: 'kosk',
+    }];
+
+    const foundExample = examples.find((example) => example.id === id);
+
+    if (!foundExample) {
+      return Promise.reject(new Error('Example not found'));
+    }
+
+    return Promise.resolve(foundExample);
+  }
+}

src/modules/example/ExampleService.ts

@@ -0,0 +1,28 @@
+import { inject, injectable } from 'tsyringe';
+import { ExampleRequest, ExampleResponse } from './dtos/Example';
+
+import { IExampleService } from '../../interfaces/service/IExampleService';
+import { IExampleRepository } from '../../interfaces/repository/IExampleRepository';
+
+import { ERROR_CLASSES } from '../../util/error.util';
+
+@injectable()
+export default class ExampleService implements IExampleService {
+  constructor(
+    @inject('IExampleRepository')
+    private repository: IExampleRepository,
+  ) {
+    console.log('Example Service Loaded!')
+  }
+
+  async getExample(id:number): Promise<ExampleResponse> {
+    let example;
+    try {
+      example = await this.repository.getExample(id);
+    } catch (error) {
+      throw new ERROR_CLASSES.ExampleError();
+    }
+
+    return example;
+  }
+}

src/modules/example/dtos/Example.ts

@@ -0,0 +1,13 @@
+export type Example = {
+    id: number;
+    name: string;
+  };
+
+export type ExampleResponse = {
+  id: number;
+  name: string;
+};
+
+export type ExampleRequest = {
+  id: number;
+};

src/server.ts

@@ -1,14 +1,12 @@
-import * as bodyParser from 'body-parser';
-import * as cors from 'cors';
+import bodyParser from 'body-parser';
+import cors from 'cors';
 import helmet from 'helmet';
 import { errors } from 'celebrate';
 import config from './config';
 import App from './app';
 import loggerMiddleware from './middleware/logger.middleware';
 import errorMiddleware from './middleware/error.middleware';
 
-import { ContainerLogic } from './logic/container.logic';
-
 import('express-async-errors');
 
 const app = new App({
@@ -20,7 +18,6 @@ const app = new App({
     cors(),
     helmet(),
   ],
-  routes: ContainerLogic.getRouteClasses(),
   lateMiddlewares: [
     errors({ statusCode: 422 }),
     errorMiddleware,