test: add explicit body examples test

nestjs · Oct 23, 2024 · e8a8453 · e8a8453
1 parent 9b61193
commit e8a8453
Show file tree

Hide file tree

Showing 3 changed files with 98 additions and 7 deletions.
diff --git a/e2e/api-spec.json b/e2e/api-spec.json
@@ -409,6 +409,70 @@
         ]
       }
     },
+    "/api/cats/explicit-body": {
+      "post": {
+        "operationId": "CatsController_createExplicitBody",
+        "parameters": [
+          {
+            "name": "header",
+            "in": "header",
+            "description": "Test",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "default": "test"
+            }
+          },
+          {
+            "name": "x-tenant-id",
+            "in": "header",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CreateCatDto"
+              },
+              "examples": {
+                "mau": {
+                  "summary": "Mau example",
+                  "value": {
+                    "name": "Mau cat",
+                    "age": 5,
+                    "breed": "Mau"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": ""
+          }
+        },
+        "tags": [
+          "cats"
+        ],
+        "security": [
+          {
+            "key2": [],
+            "key1": []
+          },
+          {
+            "bearer": []
+          },
+          {
+            "basic": []
+          }
+        ]
+      }
+    },
     "/api/cats/{id}": {
       "get": {
         "operationId": "CatsController_findOne",

diff --git a/e2e/src/cats/cats.controller.ts b/e2e/src/cats/cats.controller.ts
@@ -1,6 +1,7 @@
 import { Body, Controller, Get, Param, Post, Query } from '@nestjs/common';
 import {
   ApiBearerAuth,
+  ApiBody,
   ApiConsumes,
   ApiExtension,
   ApiHeader,
@@ -44,6 +45,24 @@ export class CatsController {
     return this.catsService.create(createCatDto);
   }
 
+  @Post('explicit-body')
+  @ApiBody({
+    type: CreateCatDto,
+    examples: {
+      mau: {
+        summary: 'Mau example',
+        value: {
+          name: 'Mau cat',
+          age: 5,
+          breed: 'Mau'
+        }
+      }
+    }
+  })
+  async createExplicitBody(@Body() createCatDto: CreateCatDto): Promise<Cat> {
+    return this.catsService.create(createCatDto);
+  }
+
   @Get(':id')
   @ApiResponse({
     status: 200,
@@ -59,9 +78,9 @@ export class CatsController {
   @ApiExtension('x-codeSamples', [
     { lang: 'JavaScript', source: "console.log('Hello World');" }
   ])
-  @ApiExtension('x-multiple', { test: "test" })
-  @ApiTags("tag1")
-  @ApiTags("tag2")
+  @ApiExtension('x-multiple', { test: 'test' })
+  @ApiTags('tag1')
+  @ApiTags('tag2')
   findAll(@Query() paginationQuery: PaginationQuery) {}
 
   @ApiQuery({ type: PaginationQuery })
@@ -95,7 +114,7 @@ export class CatsController {
   @Get('with-enum/:type')
   @ApiParam({
     name: 'type',
-    enum: LettersEnum,
+    enum: LettersEnum
   })
   getWithEnumParam(@Param('type') type: LettersEnum) {}
 

diff --git a/test/explorer/swagger-explorer.spec.ts b/test/explorer/swagger-explorer.spec.ts
@@ -92,7 +92,7 @@ describe('SwaggerExplorer', () => {
 
       @ApiProperty({
         enum: () => LettersEnum,
-        enumName: 'LettersEnum',
+        enumName: 'LettersEnum'
       })
       enumFunction: LettersEnum;
     }
@@ -979,7 +979,11 @@ describe('SwaggerExplorer', () => {
       })
       @ApiQuery({ name: 'order', enum: QueryEnum })
       @ApiQuery({ name: 'page', enum: ['d', 'e', 'f'] })
-      find(@Param('objectId') objectId: ParamEnum, @Query('order') order: QueryEnum, @Query('page') page: 'd' | 'e' | 'f'): Promise<Foo[]> {
+      find(
+        @Param('objectId') objectId: ParamEnum,
+        @Query('order') order: QueryEnum,
+        @Query('page') page: 'd' | 'e' | 'f'
+      ): Promise<Foo[]> {
         return Promise.resolve([]);
       }
     }
@@ -999,7 +1003,11 @@ describe('SwaggerExplorer', () => {
         enumName: 'QueryEnum',
         isArray: true
       })
-      findBar(@Param('objectId') objectId: ParamEnum, @Query('order') order: QueryEnum, @Query('page') page: QueryEnum[]): Promise<Foo> {
+      findBar(
+        @Param('objectId') objectId: ParamEnum,
+        @Query('order') order: QueryEnum,
+        @Query('page') page: QueryEnum[]
+      ): Promise<Foo> {
         return Promise.resolve(null);
       }
     }