- Working on test server

Author: ferdikoomen

test/server/src/AppModule.ts

@@ -1,7 +1,12 @@
 import { Module } from '@nestjs/common';
 
+import { DefaultsController } from './controllers/DefaultsController';
+import { ParametersController } from './controllers/ParametersController';
+import { ResponseController } from './controllers/ResponseController';
+import { SimpleController } from './controllers/SimpleController';
+
 @Module({
-    controllers: [],
+    controllers: [SimpleController, ParametersController, DefaultsController, ResponseController],
 })
 export class AppModule {
     //

test/server/src/controllers/DefaultsController.ts

@@ -0,0 +1,20 @@
+import { Controller, Get, Param } from '@nestjs/common';
+import { ApiResponse, ApiTags } from '@nestjs/swagger';
+
+import { ModelWithString } from '../models/ModelWithString';
+
+/* eslint-disable @typescript-eslint/no-unused-vars */
+@ApiTags('defaults')
+@Controller('defaults')
+export class DefaultsController {
+    @Get('monkey')
+    @ApiResponse({
+        status: 200,
+        type: ModelWithString,
+    })
+    monkey(@Param('id') id: string): ModelWithString {
+        return {
+            prop: 'Hello World!',
+        };
+    }
+}

test/server/src/controllers/ParametersController.ts

@@ -0,0 +1,20 @@
+import { Controller, Get, Param } from '@nestjs/common';
+import { ApiResponse, ApiTags } from '@nestjs/swagger';
+
+import { ModelWithString } from '../models/ModelWithString';
+
+/* eslint-disable @typescript-eslint/no-unused-vars */
+@ApiTags('parameters')
+@Controller('parameters')
+export class ParametersController {
+    @Get('monkey')
+    @ApiResponse({
+        status: 200,
+        type: ModelWithString,
+    })
+    monkey(@Param('id') id: string): ModelWithString {
+        return {
+            prop: 'Hello World!',
+        };
+    }
+}

test/server/src/controllers/ResponseController.ts

@@ -0,0 +1,20 @@
+import { Controller, Get, Param } from '@nestjs/common';
+import { ApiResponse, ApiTags } from '@nestjs/swagger';
+
+import { ModelWithString } from '../models/ModelWithString';
+
+/* eslint-disable @typescript-eslint/no-unused-vars */
+@ApiTags('response')
+@Controller('response')
+export class ResponseController {
+    @Get('monkey')
+    @ApiResponse({
+        status: 200,
+        type: ModelWithString,
+    })
+    monkey(@Param('id') id: string): ModelWithString {
+        return {
+            prop: 'Hello World!',
+        };
+    }
+}

test/server/src/controllers/SimpleController.ts

@@ -0,0 +1,20 @@
+import { Controller, Get, Param } from '@nestjs/common';
+import { ApiResponse, ApiTags } from '@nestjs/swagger';
+
+import { ModelWithString } from '../models/ModelWithString';
+
+/* eslint-disable @typescript-eslint/no-unused-vars */
+@ApiTags('simple')
+@Controller('simple')
+export class SimpleController {
+    @Get('monkey')
+    @ApiResponse({
+        status: 200,
+        type: ModelWithString,
+    })
+    monkey(@Param('id') id: string): ModelWithString {
+        return {
+            prop: 'Hello World!',
+        };
+    }
+}

test/server/src/main.ts

@@ -1,15 +1,12 @@
-import {NestFactory} from '@nestjs/core';
-import {DocumentBuilder, SwaggerModule} from '@nestjs/swagger';
-import {AppModule} from './AppModule';
+import { NestFactory } from '@nestjs/core';
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
+
+import { AppModule } from './AppModule';
 
 async function bootstrap(): Promise<void> {
     const app = await NestFactory.create(AppModule);
 
-    const options = new DocumentBuilder()
-        .setTitle('OpenAPI')
-        .setDescription('The OpenAPI description')
-        .setVersion('1.0')
-        .build();
+    const options = new DocumentBuilder().setTitle('OpenAPI').setDescription('The OpenAPI description').setVersion('1.0').build();
 
     const document = SwaggerModule.createDocument(app, options);
 

test/server/src/models/ModelThatExtends.ts

@@ -0,0 +1,6 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export class ModelThatExtends {
+    @ApiProperty()
+    prop?: number;
+}

test/server/src/models/ModelThatExtendsExtends.ts

@@ -0,0 +1,6 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export class ModelThatExtendsExtends {
+    @ApiProperty()
+    prop?: number;
+}

test/server/src/models/ModelWithArray.ts

@@ -0,0 +1,6 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export class ModelWithArray {
+    @ApiProperty()
+    prop?: number;
+}

test/server/src/models/ModelWithBoolean.ts

@@ -0,0 +1,6 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export class ModelWithBoolean {
+    @ApiProperty()
+    prop?: number;
+}