Merge branch 'patch-1' of https://github.com/tiholic/swagger into tih…

…olic-patch-1
nestjs · Oct 24, 2024 · c951592 · c951592
2 parents 1a0e944 + bbb112d
commit c951592
Show file tree

Hide file tree

Showing 4 changed files with 84 additions and 3 deletions.
diff --git a/e2e/api-spec.json b/e2e/api-spec.json
@@ -966,6 +966,58 @@
           }
         ]
       }
+    },
+    "/api/cats/download": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "binary file for download",
+            "content": {
+              "application/pdf": {
+                "schema": {
+                  "type": "string",
+                  "format": "binary"
+                }
+              },
+              "image/jpeg": {
+                "schema": {
+                  "type": "string",
+                  "format": "binary"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "cats"
+        ],
+        "security": [
+          {
+            "key2": [],
+            "key1": []
+          },
+          {
+            "bearer": []
+          },
+          {
+            "basic": []
+          }
+        ],
+        "operationId": "CatsController_download",
+        "summary": "",
+        "parameters": [
+          {
+            "name": "header",
+            "in": "header",
+            "description": "Test",
+            "required": false,
+            "schema": {
+              "default": "test",
+              "type": "string"
+            }
+          }
+        ]
+      }
     }
   },
   "info": {

diff --git a/e2e/src/cats/cats.controller.ts b/e2e/src/cats/cats.controller.ts
@@ -134,4 +134,18 @@ export class CatsController {
     maxLength: 100
   } as any)
   getWithRandomQuery(@Query('type') type: string) {}
+
+  @Get('download')
+  @ApiOperation({
+    responses: {
+      '200': {
+        description: 'binary file for download',
+        content: {
+          'application/pdf': { schema: { type: 'string', format: 'binary' } },
+          'image/jpeg': { schema: { type: 'string', format: 'binary' } }
+        }
+      }
+    }
+  })
+  download() {}
 }
diff --git a/e2e/validate-schema.e2e-spec.ts b/e2e/validate-schema.e2e-spec.ts
@@ -170,4 +170,19 @@ describe('Validate OpenAPI schema', () => {
     expect(api.components.schemas).toHaveProperty('Person');
     expect(api.components.schemas).toHaveProperty('Cat');
   });
+
+  it('should consider explicit config over auto-detected schema', async () => {
+    const document = SwaggerModule.createDocument(app, options);
+    expect(document.paths['/api/cats/download'].get.responses).toEqual({
+      '200': {
+        description: 'binary file for download',
+        content: {
+          'application/pdf': {
+            schema: { type: 'string', format: 'binary' }
+          },
+          'image/jpeg': { schema: { type: 'string', format: 'binary' } }
+        }
+      }
+    })
+  });
 });
diff --git a/lib/swagger-transformer.ts b/lib/swagger-transformer.ts
@@ -18,9 +18,9 @@ export class SwaggerTransformer {
         ({ root }: Record<'root', any>) => root.method
       );
       return mapValues(keyByMethod, (route: any) => {
-        return {
-          ...omit(route.root, ['method', 'path']),
-          ...omit(route, 'root')
+        return {	
+          ...omit(route, 'root'),
+          ...omit(route.root, ['method', 'path'])
         };
       });
     });