add openapi Documentation

sk337 · Feb 3, 2024 · 578a1e8 · 578a1e8
1 parent a7edc6b
commit 578a1e8
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/api/src/main.ts b/api/src/main.ts
@@ -6,11 +6,20 @@ import * as passport from 'passport';
 import { AppModule } from './app.module';
 import { ExcludeInterceptor } from './exclude.interceptor';
 import { config } from './config';
+import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
 import * as fs from 'fs';
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
 
+  // creates open api documentation at /api
+  const swaggerConfig = new DocumentBuilder()
+    .setTitle('SwordBattle.io Api')
+    .setDescription('The SwordBattle.io API Documentation')
+    .setVersion('1.0')
+    .build();
+  const document = SwaggerModule.createDocument(app, swaggerConfig);
+  SwaggerModule.setup('api', app, document);
 
   app.use(cookieParser(config.appSecret));
   app.enableCors({