feat: add option to exclude specific stages (#46) (#47)

* feat: Only deploy swagger on specified stages (#46) * Refactor to excluded stages * update readme with excludeStages option * Update src/ServerlessAutoSwagger.ts Co-authored-by: Brandon Faulkner <[email protected]> * Update src/ServerlessAutoSwagger.ts Co-authored-by: Brandon Faulkner <[email protected]> Co-authored-by: jochem <[email protected]> Co-authored-by: Brandon Faulkner <[email protected]>
completecoding · Feb 23, 2022 · 89335dd · 89335dd
1 parent 5ab25dc
commit 89335dd
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -41,6 +41,7 @@ custom:
         useStage?: true | false
         basePath?: '/string'
         schemes?: ['http', 'https', 'ws', 'wss']
+        excludeStages?: ['production', 'anyOtherStage']
 ```
 
 `generateSwaggerOnDeploy` is a boolean which decides whether to generate a new swagger file on deployment. Default is `true`.
@@ -64,6 +65,8 @@ apiKeyHeaders: ['Authorization', 'x-api-key']
 
 `schemes` is an optional array (containing one of `http`, `https`, `ws`, or `wss`) for specifying schemes. If not provided, uses the scheme used to serve the API specification (reflecting Swagger's behavior)
 
+`excludeStages` is an optional array of strings that should contain stages you do **not** want Swagger UI and Swagger JSON to be deployed in.
+
 ## Adding more details
 
 The default swagger file from vanilla Serverless framework will have the correct paths and methods but no details about the requests or responses.

diff --git a/src/ServerlessAutoSwagger.ts b/src/ServerlessAutoSwagger.ts
@@ -150,6 +150,12 @@ class ServerlessAutoSwagger {
   };
 
   predeploy = async () => {
+    const stage = this.serverless.service.provider.stage;
+    const excludedStages = this.serverless.service.custom?.autoswagger?.excludeStages;
+    if (excludedStages?.includes(stage)) {
+      console.log(`Swagger lambdas will not be deployed for stage [${stage}], as they have been marked for exclusion.`);
+      return;
+    }
     const generateSwaggerOnDeploy =
       this.serverless.service.custom?.autoswagger?.generateSwaggerOnDeploy;
     if (generateSwaggerOnDeploy === undefined || generateSwaggerOnDeploy) {

diff --git a/src/serverlessPlugin.d.ts b/src/serverlessPlugin.d.ts
@@ -46,6 +46,7 @@ export interface AutoSwaggerCustomConfig {
     swaggerPath?: string
     basePath?: string
     schemes?: SwaggerScheme[]
+    excludeStages?: string[]
   }
 }