feat: add openapi documentation

src/app.module.ts

@@ -17,6 +17,7 @@ import { FeatureConfigService } from './config/featureconfig/featureconfig.servi
 import { PrismaModule } from './prisma/prisma.module';
 import { MetricsService } from './monitoring/metrics/metrics.service';
 import { PrismaService } from './prisma/prisma.service';
+import appConfig, { appConfigSchema } from './config/app.config';
 
 @Module({
     imports: [
@@ -28,11 +29,12 @@ import { PrismaService } from './prisma/prisma.service';
             isGlobal: true,
             cache: true,
             expandVariables: true,
-            load: [serverConfig, monitoringConfig],
+            load: [serverConfig, monitoringConfig, appConfig],
             validationSchema: Joi.object({
                 ...serverConfigSchema,
                 ...metricsConfigSchema,
                 ...healthCheckConfigSchema,
+                ...appConfigSchema,
             }),
         }),
         MetricsModule,

src/config/app.config.ts

@@ -0,0 +1,14 @@
+import { registerAs } from '@nestjs/config';
+import Joi from 'joi';
+
+export default registerAs('app', () => ({
+    name: process.env.npm_package_name,
+    description: process.env.npm_package_description,
+    version: process.env.npm_package_version,
+}));
+
+export const appConfigSchema = {
+    NAME: Joi.string(),
+    DESCRIPTION: Joi.string(),
+    VERSION: Joi.string(),
+};

src/main.ts

@@ -2,17 +2,30 @@ import { NestFactory, PartialGraphHost } from '@nestjs/core';
 import { AppModule } from './app.module';
 import { writeFileSync } from 'fs';
 import { ConfigService } from '@nestjs/config';
+import { DocumentBuilder, OpenAPIObject, SwaggerModule } from '@nestjs/swagger';
+import { INestApplication } from '@nestjs/common';
 
 async function bootstrap() {
-    const app = await NestFactory.create(AppModule, {
+    const app: INestApplication = await NestFactory.create(AppModule, {
         snapshot: true,
         abortOnError: false,
     });
 
-    const configService = app.get(ConfigService);
+    const configService: ConfigService<any, boolean> = app.get(ConfigService);
     const port = configService.get('server.port');
     const hostName = configService.get('server.hostname');
 
+    const docsConfig: Omit<OpenAPIObject, 'paths'> = new DocumentBuilder()
+        .setTitle(configService.get('app.name'))
+        .setDescription(configService.get('app.description'))
+        .setVersion(configService.get('app.version'))
+        .build();
+    const document: OpenAPIObject = SwaggerModule.createDocument(
+        app,
+        docsConfig,
+    );
+    SwaggerModule.setup('documentation', app, document);
+
     await app.listen(port, hostName);
 }
 

src/monitoring/health/health.controller.ts

@@ -2,6 +2,7 @@ import { Controller, Get, Inject } from '@nestjs/common';
 import { ConfigService } from '@nestjs/config';
 import {
     HealthCheck,
+    HealthCheckResult,
     HealthCheckService,
     HttpHealthIndicator,
 } from '@nestjs/terminus';
@@ -16,11 +17,14 @@ export class HealthController {
 
     @Get()
     @HealthCheck()
-    check() {
+    check(): Promise<HealthCheckResult> {
         const indicators = [];
         const baseUrl = this.config.get('server.baseUrl');
 
         indicators.push(() => this.http.pingCheck('API', `${baseUrl}/`));
+        indicators.push(() =>
+            this.http.pingCheck('Documentation', `${baseUrl}/documentation`),
+        );
 
         return this.health.check(indicators);
     }