feat: allow the swagger path to be configurable

SciCatProject · Sep 19, 2024 · 1d2f8c6 · 1d2f8c6
1 parent 2a450ad
commit 1d2f8c6
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -175,6 +175,7 @@ Valid environment variables for the .env file. See [.env.example](/.env.example)
 | `ES_FIELDS_LIMIT` | number | | The total number of fields in an index. | 1000 |
 | `ES_REFRESH` | string | | If set to `wait_for`, Elasticsearch will wait till data is inserted into the specified index before returning a response. | false |
 | `LOGGERS_CONFIG_FILE` | string | | The file name for loggers configuration, located in the project root directory. | "loggers.json" |
+| `SWAGGER_PATH` | string | Yes | swaggerPath is the path where the swagger UI will be available| "explorer"|
 
 ## Migrating from the old SciCat Backend
 

diff --git a/src/main.ts b/src/main.ts
@@ -36,8 +36,9 @@ async function bootstrap() {
       docExpansion: "none",
     },
   };
+  const swaggerPath = process.env.SWAGGER_PATH || "explorer";
 
-  SwaggerModule.setup("explorer", app, document, swaggerOptions);
+  SwaggerModule.setup(swaggerPath, app, document, swaggerOptions);
 
   app.useGlobalPipes(
     /**