Swagger and simple configuration

.gitignore

@@ -32,4 +32,6 @@ lerna-debug.log*
 !.vscode/settings.json
 !.vscode/tasks.json
 !.vscode/launch.json
-!.vscode/extensions.json
+!.vscode/extensions.json
+
+/configuration.ts

.prettierrc

@@ -1,4 +1,6 @@
 {
   "singleQuote": true,
-  "trailingComma": "all"
-}
+  "trailingComma": "all",
+  "printWidth": 120,
+  "useTabs": false
+}

configuration.default.ts

@@ -0,0 +1,19 @@
+export interface IAppConfig {
+  port: number;
+  apiPrefix: string;
+  useOpenApi: boolean;
+  dbHost: string;
+  dbPort: number;
+  dbUsername: string;
+  dbPassword: string;
+  dbName: string;
+}
+
+export default (): Partial<IAppConfig> => ({
+  port: 4100,
+  apiPrefix: '/api',
+  useOpenApi: true,
+  dbHost: 'localhost',
+  dbPort: 5432,
+  dbName: 'cat-cafe',
+});

package.json

@@ -21,8 +21,10 @@
   },
   "dependencies": {
     "@nestjs/common": "^9.0.0",
+    "@nestjs/config": "^2.3.0",
     "@nestjs/core": "^9.0.0",
     "@nestjs/platform-express": "^9.0.0",
+    "@nestjs/swagger": "^6.1.4",
     "reflect-metadata": "^0.1.13",
     "rxjs": "^7.2.0"
   },

src/app.module.ts

@@ -1,9 +1,15 @@
 import { Module } from '@nestjs/common';
 import { AppController } from './app.controller';
 import { AppService } from './app.service';
+import { ConfigModule } from '@nestjs/config';
+import configuration from '../configuration';
 
 @Module({
-  imports: [],
+  imports: [
+    ConfigModule.forRoot({
+      load: [configuration],
+    }),
+  ],
   controllers: [AppController],
   providers: [AppService],
 })

src/main.ts

@@ -1,8 +1,29 @@
 import { NestFactory } from '@nestjs/core';
 import { AppModule } from './app.module';
+import { ConfigService } from '@nestjs/config';
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
+import * as packageInfo from '../package.json';
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
-  await app.listen(3000);
+
+  const configService = app.get(ConfigService);
+  const apiPrefix = configService.get<string>('apiPrefix', 'api');
+  const useOpenApi = configService.get<boolean>('useOpenApi', false);
+
+  if (useOpenApi) {
+    const options = new DocumentBuilder()
+      .setTitle(packageInfo.name)
+      .setDescription(`${packageInfo.name} API`)
+      .setVersion(packageInfo.version)
+      .build();
+
+    const document = SwaggerModule.createDocument(app, options);
+    SwaggerModule.setup(`${apiPrefix}/openapi`, app, document);
+  }
+
+  app.setGlobalPrefix(apiPrefix);
+  await app.listen(configService.get<number>('port') || 3000);
 }
+
 bootstrap();

tsconfig.json

@@ -16,6 +16,7 @@
     "noImplicitAny": false,
     "strictBindCallApply": false,
     "forceConsistentCasingInFileNames": false,
-    "noFallthroughCasesInSwitch": false
+    "noFallthroughCasesInSwitch": false,
+    "resolveJsonModule": true
   }
 }