Merge pull request #1425 from SciCatProject/SWAP-4199-scicat-be-make-swagger-url-configurable-

feat: allow the swagger path to be configurable

Author: nitrosx

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
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "scicat-backend-next",
-  "version": "4.0.0",
+  "version": "4.5.0",
   "description": "scicat-backend-next",
   "author": "",
   "private": true,

src/config/configuration.ts

@@ -58,6 +58,10 @@ const configuration = () => {
   });
 
   const config = {
+    versions: {
+      api: "v3",
+    },
+    swaggerPath: process.env.SWAGGER_PATH || "explorer",
     loggerConfigs: jsonConfigMap.loggers || [defaultLogger],
     adminGroups: adminGroups.split(",").map((v) => v.trim()) ?? [],
     deleteGroups: deleteGroups.split(",").map((v) => v.trim()) ?? [],

src/main.ts

@@ -15,6 +15,11 @@ async function bootstrap() {
   const app = await NestFactory.create(AppModule, {
     bufferLogs: true,
   });
+  const configService: ConfigService<Record<string, unknown>, false> = app.get(
+    ConfigService,
+  );
+  const apiVersion = configService.get<string>("versions.api");
+  const swaggerPath = `${configService.get<string>("swaggerPath")}`;
 
   const scicatLogger = app.get<ScicatLogger>(ScicatLogger);
 
@@ -23,21 +28,23 @@ async function bootstrap() {
   app.useGlobalFilters(new AllExceptionsFilter(scicatLogger));
 
   app.enableCors();
-  app.setGlobalPrefix("api/v3");
+
+  app.setGlobalPrefix(`api/${apiVersion}`);
   const config = new DocumentBuilder()
     .setTitle("SciCat backend API")
     .setDescription("This is the API for the SciCat Backend")
-    .setVersion("" + process.env.npm_package_version)
+    .setVersion(`api/${apiVersion}`)
     .addBearerAuth()
     .build();
+
   const document = SwaggerModule.createDocument(app, config);
   const swaggerOptions: SwaggerCustomOptions = {
     swaggerOptions: {
       docExpansion: "none",
     },
   };
 
-  SwaggerModule.setup("explorer", app, document, swaggerOptions);
+  SwaggerModule.setup(swaggerPath, app, document, swaggerOptions);
 
   app.useGlobalPipes(
     /**
@@ -70,10 +77,6 @@ async function bootstrap() {
 
   app.use(json({ limit: "16mb" }));
 
-  const configService: ConfigService<Record<string, unknown>, false> = app.get(
-    ConfigService,
-  );
-
   const expressSessionSecret = configService.get<string>(
     "expressSessionSecret",
   );