Merge pull request #252 from porters-xyz/add-oai-specs

added swagger module
porters-xyz · May 15, 2024 · 640f847 · 640f847
2 parents 5bc07e4 + 8f5e33f
commit 640f847
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/web-portal/backend/package.json b/web-portal/backend/package.json
@@ -30,6 +30,7 @@
     "@nestjs/core": "^10.0.0",
     "@nestjs/platform-express": "^10.0.0",
     "@nestjs/schedule": "^4.0.2",
+    "@nestjs/swagger": "^7.3.1",
     "@prisma/client": "^5.9.1",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.1",

diff --git a/web-portal/backend/src/main.ts b/web-portal/backend/src/main.ts
@@ -1,4 +1,5 @@
 import { HttpAdapterHost, NestFactory } from '@nestjs/core';
+import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
 import { PrismaClientExceptionFilter } from 'nestjs-prisma';
 import { AppModule } from './app.module';
 import * as cookieParser from 'cookie-parser';
@@ -8,9 +9,14 @@ async function bootstrap() {
   // const { httpAdapter } = app.get(HttpAdapterHost);
   // app.useGlobalFilters(new PrismaClientExceptionFilter(httpAdapter));
 
-  // Remove CORS in prod
-
-  app.enableCors();
+  const config = new DocumentBuilder()
+    .setTitle('Gateway Web-Portal Backend')
+    .setDescription('Backend APIs')
+    .setVersion('1.0')
+    .addTag('specs')
+    .build();
+  const document = SwaggerModule.createDocument(app, config);
+  SwaggerModule.setup('specs', app, document);
 
   app.use(cookieParser());