test: include external metadata in e2e tests

nestjs · Jun 5, 2023 · bf4a27e · bf4a27e
1 parent 27d9e9a
commit bf4a27e
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 4 deletions.
diff --git a/e2e/api-spec.json b/e2e/api-spec.json
@@ -586,6 +586,7 @@
     "/api/cats/bulk": {
       "get": {
         "operationId": "CatsController_findAllBulk",
+        "summary": "Find all cats in bulk",
         "parameters": [
           {
             "name": "header",
@@ -607,7 +608,17 @@
         ],
         "responses": {
           "200": {
-            "description": ""
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/Cat"
+                  }
+                }
+              }
+            }
           }
         },
         "tags": [
@@ -992,6 +1003,7 @@
         "type": "object",
         "properties": {
           "name": {
+            "description": "Name of the cat",
             "type": "string"
           },
           "age": {
@@ -1080,6 +1092,11 @@
             "description": "The breed of the Cat"
           },
           "_tags": {
+            "description": "Tags of the cat",
+            "example": [
+              "tag1",
+              "tag2"
+            ],
             "type": "array",
             "items": {
               "type": "string"

diff --git a/e2e/validate-schema.e2e-spec.ts b/e2e/validate-schema.e2e-spec.ts
@@ -1,6 +1,7 @@
 import { INestApplication } from '@nestjs/common';
 import { NestFactory } from '@nestjs/core';
 import { writeFileSync } from 'fs';
+import { OpenAPIV3 } from 'openapi-types';
 import { join } from 'path';
 import * as SwaggerParser from 'swagger-parser';
 import {
@@ -12,7 +13,6 @@ import {
 import { ApplicationModule } from './src/app.module';
 import { Cat } from './src/cats/classes/cat.class';
 import { TagDto } from './src/cats/dto/tag.dto';
-import { OpenAPIV3 } from 'openapi-types';
 
 describe('Validate OpenAPI schema', () => {
   let app: INestApplication;
@@ -49,7 +49,48 @@ describe('Validate OpenAPI schema', () => {
   });
 
   it('should produce a valid OpenAPI 3.0 schema', async () => {
-    const document = SwaggerModule.createDocument(app, options);
+    const document = SwaggerModule.createDocument(app, options, {
+      metadata: {
+        '@nestjs/swagger': {
+          models: [
+            [
+              require('./src/cats/classes/cat.class'),
+              {
+                Cat: {
+                  tags: {
+                    description: 'Tags of the cat',
+                    example: ['tag1', 'tag2']
+                  }
+                }
+              }
+            ],
+            [
+              require('./src/cats/dto/create-cat.dto'),
+              {
+                CreateCatDto: {
+                  name: {
+                    description: 'Name of the cat'
+                  }
+                }
+              }
+            ]
+          ],
+          controllers: [
+            [
+              require('./src/cats/cats.controller'),
+              {
+                CatsController: {
+                  findAllBulk: {
+                    type: [require('./src/cats/classes/cat.class').Cat],
+                    summary: 'Find all cats in bulk'
+                  }
+                }
+              }
+            ]
+          ]
+        }
+      }
+    });
 
     const doc = JSON.stringify(document, null, 2);
     writeFileSync(join(__dirname, 'api-spec.json'), doc);

diff --git a/lib/explorers/api-operation.explorer.ts b/lib/explorers/api-operation.explorer.ts
@@ -34,7 +34,7 @@ function applyMetadataFactory(prototype: Type<unknown>) {
       if (Object.keys(operationMeta).length === 0) {
         return;
       }
-      ApiOperation(metadata[key], { overrideExisting: false })(
+      ApiOperation(operationMeta, { overrideExisting: false })(
         classPrototype,
         key,
         Object.getOwnPropertyDescriptor(classPrototype, key)