feat: add support for multiple authentication types

nestjs · Feb 24, 2021 · 538231c · 538231c
1 parent 9c5bdf1
commit 538231c
Show file tree

Hide file tree

Showing 6 changed files with 75 additions and 6 deletions.
diff --git a/e2e/api-spec.json b/e2e/api-spec.json
@@ -33,6 +33,16 @@
         "in": "header",
         "name": "api_key"
       },
+      "key1": {
+        "type": "apiKey",
+        "in": "header",
+        "name": "key1"
+      },
+      "key2": {
+        "type": "apiKey",
+        "in": "header",
+        "name": "key2"
+      },
       "cookie": {
         "type": "apiKey",
         "in": "cookie",
@@ -229,6 +239,10 @@
   "security": [
     {
       "bearer": []
+    },
+    {
+      "basic": [],
+      "cookie": []
     }
   ],
   "paths": {
@@ -281,6 +295,10 @@
           "create cats"
         ],
         "security": [
+          {
+            "key2": [],
+            "key1": []
+          },
           {
             "bearer": []
           },
@@ -383,6 +401,10 @@
           "cats"
         ],
         "security": [
+          {
+            "key2": [],
+            "key1": []
+          },
           {
             "bearer": []
           },
@@ -432,6 +454,10 @@
           "cats"
         ],
         "security": [
+          {
+            "key2": [],
+            "key1": []
+          },
           {
             "bearer": []
           },
@@ -536,6 +562,10 @@
           "cats"
         ],
         "security": [
+          {
+            "key2": [],
+            "key1": []
+          },
           {
             "bearer": []
           },
@@ -569,6 +599,10 @@
           "cats"
         ],
         "security": [
+          {
+            "key2": [],
+            "key1": []
+          },
           {
             "bearer": []
           },
@@ -613,6 +647,10 @@
           "cats"
         ],
         "security": [
+          {
+            "key2": [],
+            "key1": []
+          },
           {
             "bearer": []
           },
@@ -667,6 +705,10 @@
           "cats"
         ],
         "security": [
+          {
+            "key2": [],
+            "key1": []
+          },
           {
             "bearer": []
           },
@@ -700,6 +742,10 @@
           "cats"
         ],
         "security": [
+          {
+            "key2": [],
+            "key1": []
+          },
           {
             "bearer": []
           },

diff --git a/e2e/fastify.e2e-spec.ts b/e2e/fastify.e2e-spec.ts
@@ -27,8 +27,11 @@ describe('Fastify Swagger', () => {
       .addBearerAuth()
       .addOAuth2()
       .addApiKey()
+      .addApiKey({ type: 'apiKey' }, 'key1')
+      .addApiKey({ type: 'apiKey' }, 'key2')
       .addCookieAuth()
-      .addSecurityRequirements('bearer');
+      .addSecurityRequirements('bearer')
+      .addSecurityRequirements({ basic: [], cookie: [] });
   });
 
   it('should produce a valid OpenAPI 3.0 schema', async () => {

diff --git a/e2e/src/cats/cats.controller.ts b/e2e/src/cats/cats.controller.ts
@@ -17,6 +17,7 @@ import { PaginationQuery } from './dto/pagination-query.dto';
 
 @ApiSecurity('basic')
 @ApiBearerAuth()
+@ApiSecurity({ key2: [], key1: [] })
 @ApiTags('cats')
 @ApiHeader({
   name: 'header',

diff --git a/e2e/validate-schema.e2e-spec.ts b/e2e/validate-schema.e2e-spec.ts
@@ -24,8 +24,11 @@ describe('Validate OpenAPI schema', () => {
       .addBearerAuth()
       .addOAuth2()
       .addApiKey()
+      .addApiKey({ type: 'apiKey' }, 'key1')
+      .addApiKey({ type: 'apiKey' }, 'key2')
       .addCookieAuth()
       .addSecurityRequirements('bearer')
+      .addSecurityRequirements({ basic: [], cookie: [] })
       .build();
 
     document = SwaggerModule.createDocument(app, options);

diff --git a/lib/decorators/api-security.decorator.ts b/lib/decorators/api-security.decorator.ts
@@ -1,12 +1,19 @@
+import { isString } from 'lodash';
 import { DECORATORS } from '../constants';
 import { SecurityRequirementObject } from '../interfaces/open-api-spec.interface';
 import { extendMetadata } from '../utils/extend-metadata.util';
 
 export function ApiSecurity(
-  name: string,
+  name: string | SecurityRequirementObject,
   requirements: string[] = []
 ): ClassDecorator & MethodDecorator {
-  let metadata: SecurityRequirementObject[] = [{ [name]: requirements }];
+  let metadata: SecurityRequirementObject[];
+
+  if (isString(name)) {
+    metadata = [{ [name]: requirements }];
+  } else {
+    metadata = [name];
+  }
 
   return (
     target: object,

diff --git a/lib/document-builder.ts b/lib/document-builder.ts
@@ -1,9 +1,10 @@
 import { Logger } from '@nestjs/common';
-import { isUndefined, negate, pickBy } from 'lodash';
+import { isString, isUndefined, negate, pickBy } from 'lodash';
 import { buildDocumentBase } from './fixtures/document.base';
 import { OpenAPIObject } from './interfaces';
 import {
   ExternalDocumentationObject,
+  SecurityRequirementObject,
   SecuritySchemeObject,
   ServerVariableObject,
   TagObject
@@ -91,11 +92,19 @@ export class DocumentBuilder {
   }
 
   public addSecurityRequirements(
-    name: string,
+    name: string | SecurityRequirementObject,
     requirements: string[] = []
   ): this {
+    let securityRequirement: SecurityRequirementObject;
+
+    if (isString(name)) {
+      securityRequirement = { [name]: requirements };
+    } else {
+      securityRequirement = name;
+    }
+
     this.document.security = (this.document.security || []).concat({
-      [name]: requirements
+      ...securityRequirement
     });
     return this;
   }